Add Manual DocC Documentation Publishing Workflow#370
Merged
MikeThorntonPayPal merged 5 commits intomainfrom Feb 5, 2026
Merged
Add Manual DocC Documentation Publishing Workflow#370MikeThorntonPayPal merged 5 commits intomainfrom
MikeThorntonPayPal merged 5 commits intomainfrom
Conversation
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Create ci script with commands to generate and serve docs locally - Update .gitignore to exclude generated docs and archives Usage: ./ci generate_docs # Generate DocC reference documentation ./ci serve_docs # Start local server to view docs Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add @_documentation(visibility: private) attribute to classes, structs, and enums that are internal implementation details and should not appear in public documentation. This improves the clarity of the generated DocC documentation by hiding types that developers should not directly use. Changes: - CorePayments: HTTPMethod, HTTPHeader, NetworkingError, WebAuthenticationSession, CorePaymentsError - CardPayments: PaymentSource - PaymentButtons: Coordinator Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Refactor to use shared ci script for doc generation instead of duplicating the code in the GitHub Action workflow. This ensures consistency between local and CI documentation generation and makes the code easier to maintain. Changes: - Update ci script to accept optional hosting base path parameter - Simplify publish-docs.yml to call ./ci generate_docs - Workflow only handles environment-specific logic (badges, publishing) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
MikeThorntonPayPal
force-pushed
the
add-manual-docs-workflow
branch
from
f12379d to
1fbafea
Compare
MikeThorntonPayPal
changed the title
MikeThorntonPayPal
changed the title
sshropshire
approved these changes
Feb 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive DocC documentation generation with both local development and
automated publishing workflows.
Changes
Local Documentation Generation
ciscript for generating and serving docs locally./ci generate_docsand./ci serve_docsDocC Visibility Control
Manual Publishing Workflow
publish-docs.ymlworkflow with three modes:preview: Publishes docs to/previewpath with preview badgeproduction: Publishes docs to main pathcleanup-preview: Removes preview documentationUsage
Local Development:
Publishing (after merge):
Checklist
Authors