Deploy Typedoc API reference to GitHub Pages#226
Merged
Conversation
Adds a docs workflow that builds the Typedoc reference (npm run docs) and
publishes it to GitHub Pages on every push to main (and via manual dispatch),
using the official actions/upload-pages-artifact + actions/deploy-pages flow.
Typedoc config updates for a coherent published site:
- githubPages: true so a .nojekyll file is emitted (the output uses
underscore-prefixed paths that Jekyll would otherwise drop).
- projectDocuments: include the hand-written docs/{track,app,pipelines}.md
guides so they render alongside the generated API reference.
- Drop the stale PushRequestData entry from intentionallyNotExported (it is
exported as of #224) and switch the README docs/ folder link to an absolute
URL, so the docs build is warning-free.
NOTE: requires enabling GitHub Pages for the repo with Source = GitHub Actions.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mike-engel
added a commit
that referenced
this pull request
Jul 2, 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.
Adds a docs workflow that builds the Typedoc reference (
npm run docs) and publishes it to GitHub Pages on every push tomain(and via manual dispatch), using the officialactions/upload-pages-artifact+actions/deploy-pagesflow.Typedoc config updates for a coherent published site:
githubPages: true so a.nojekyllfile is emitted (the output uses underscore-prefixed paths that Jekyll would otherwise drop).projectDocuments: include the hand-writtendocs/{track,app,pipelines}.mdguides so they render alongside the generated API reference.PushRequestDataentry fromintentionallyNotExported(it is exported as of Backfill missing track API methods #224) and switch the READMEdocs/folder link to an absolute URL, so the docs build is warning-free.NOTE: requires enabling GitHub Pages for the repo with Source = GitHub Actions.
AI assisted 🤖
Note
Low Risk
Documentation and CI-only changes; no runtime SDK behavior. Requires enabling GitHub Pages with Actions as the source.
Overview
Adds a GitHub Actions workflow (
.github/workflows/docs.yml) that runsnpm run docson every push tomain(and on manual dispatch), uploads thetypedocoutput, and deploys it with the official Pages artifact +deploy-pagesflow (OIDC permissions, single concurrentpagesdeploy group).Typedoc is tuned for the published site:
githubPages: true(.nojekyllfor underscore paths),projectDocumentsfor the hand-writtendocs/track.md,docs/app.md, anddocs/pipelines.md, and removal of stalePushRequestDatafromintentionallyNotExported. The README API section now links thedocs/folder with an absolute GitHub URL.Repo setup: GitHub Pages must use Source = GitHub Actions.
Reviewed by Cursor Bugbot for commit c1a2d86. Bugbot is set up for automated code reviews on this repo. Configure here.