Skip to content

Add auto-generated API docs site (TypeDoc + GH Pages)#210

Open
Sparvovic wants to merge 2 commits into
piotrwitek:masterfrom
Sparvovic:taskrevenue/gh-361592589-typedoc-api-docs
Open

Add auto-generated API docs site (TypeDoc + GH Pages)#210
Sparvovic wants to merge 2 commits into
piotrwitek:masterfrom
Sparvovic:taskrevenue/gh-361592589-typedoc-api-docs

Conversation

@Sparvovic

@Sparvovic Sparvovic commented May 12, 2026

Copy link
Copy Markdown

Resolves #30.

What

  • Adds TypeDoc-based HTML API docs (includes search) via npm run docs:build.
  • Adds a GitHub Actions workflow that builds docs on every push to master and publishes to the gh-pages branch.
  • Adds a short README section pointing to the GitHub Pages URL (once enabled in repo settings).

Notes

  • TypeDoc is pinned to 0.16.11 to match the repo's TypeScript 3.7.x toolchain.
  • No runtime/package dependencies were added (TypeDoc is dev-only).
  • To publish the site, enable GitHub Pages: Settings → Pages → Source: gh-pages branch, / (root).

Validation

  • npm run ci-check
  • npm run docs:build

AI disclosure

This PR was prepared with AI assistance (OpenAI Codex) for drafting the config/workflow and README text; changes were reviewed and validated locally.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request implements automated API documentation generation using TypeDoc. Key changes include the addition of a docs:build script in package.json, a new typedoc.json configuration file, and updated documentation links in the README.md. Review feedback recommends including the documentation build in the CI process and cleanup scripts, and suggests adjusting the TypeDoc mode to "file" to improve the navigation structure of the generated documentation.

Comment thread package.json
Comment thread typedoc.json Outdated
@Sparvovic

Copy link
Copy Markdown
Author

Thanks for the review. Addressed in a7225ca: ci-check now runs docs:build, reinstall cleans docs/, and typedoc uses mode=file. Re-ran npm run ci-check locally and it passes.

@Sparvovic Sparvovic marked this pull request as ready for review May 13, 2026 16:47
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.

Add a web page with API documentation that will be automatically generated from the recent source code changes

1 participant