Add auto-generated API docs site (TypeDoc + GH Pages)#210
Open
Sparvovic wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
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.
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. |
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
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.
Resolves #30.
What
npm run docs:build.masterand publishes to thegh-pagesbranch.Notes
0.16.11to match the repo's TypeScript3.7.xtoolchain.gh-pagesbranch,/ (root).Validation
npm run ci-checknpm run docs:buildAI disclosure
This PR was prepared with AI assistance (OpenAI Codex) for drafting the config/workflow and README text; changes were reviewed and validated locally.