Skip to content

ci: publish DocC documentation to GitHub Pages - #27

Merged
TUNER88 merged 2 commits into
masterfrom
ci/docc-pages
Oct 18, 2026
Merged

TUNER88 merged 2 commits into
masterfrom
ci/docc-pages

Conversation

@TUNER88

@TUNER88 TUNER88 commented Oct 18, 2026

Copy link
Copy Markdown
Owner

This PR publishes the DocC documentation to GitHub Pages. It's based on master and independent of the other PRs.

  • .github/workflows/docs-pages.yml runs on push to master (and manually).
    • It builds the symbol graph, then runs docc convert --transform-for-static-hosting --hosting-base-path iOSSystemSoundsLibrary.
    • It adds a root redirect to documentation/systemsoundslibrary/.
    • It deploys with actions/upload-pages-artifact v5.0.0 and actions/deploy-pages v5.0.1 (pinned SHAs) to the github-pages environment.
  • Pages is already enabled with Source: GitHub Actions (build_type=workflow).
  • After merge, the docs will be at https://tuner88.github.io/iOSSystemSoundsLibrary/documentation/systemsoundslibrary/

This workflow only runs on master, so it adds no new PR checks. The existing Build DocC documentation check keeps validating docs on PRs.

The README link to the docs is a separate PR. Its link check can only pass once this site is live.

@TUNER88
TUNER88 merged commit d9d04b6 into master Oct 18, 2026
12 checks passed
@TUNER88
TUNER88 deleted the ci/docc-pages branch October 18, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant