Repository navigation
Add TypeDoc for API documentation generation - #24
Merged
Hector Hernandez (hectorhdzg) merged 1 commit intoApr 20, 2026
Merged
Hector Hernandez (hectorhdzg) merged 1 commit into
Hector Hernandez (hectorhdzg) merged 1 commit into
Conversation
Hector Hernandez (hectorhdzg)
commented
Apr 20, 2026
Member
- Add typedoc as a dev dependency
- Add typedoc.json config with src/index.ts as entry point
- Add 'npm run docs' script to generate HTML docs to docs/
- Add docs/ to .gitignore (generated output)
- Add docs generation step to PR validation CI (reuses existing quality job)
- Add typedoc as a dev dependency - Add typedoc.json config with src/index.ts as entry point - Add 'npm run docs' script to generate HTML docs to docs/ - Add docs/ to .gitignore (generated output) - Add docs generation step to PR validation CI (reuses existing quality job)
Hector Hernandez (hectorhdzg)
requested review from
Jackson Weber (JacksonWeber),
Nev (MSNev),
Leighton Chen (lzchen) and
Radhika Gupta (rads-1996)
as code owners
April 20, 2026 18:42
Radhika Gupta (rads-1996)
approved these changes
Apr 20, 2026
Leighton Chen (lzchen)
approved these changes
Apr 20, 2026
Copilot started reviewing on behalf of
Hector Hernandez (hectorhdzg)
April 20, 2026 18:46
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces TypeDoc-based API documentation generation for the package, wiring it into local scripts and PR validation CI to ensure docs remain buildable from the public entrypoint.
Changes:
- Add
typedocas a dev dependency and atypedoc.jsonconfig targetingsrc/index.ts. - Add
npm run docsto generate HTML docs intodocs/. - Ignore generated
docs/output and run doc generation during PR validation.
Reviewed changes
Copilot reviewed 3 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| typedoc.json | Adds TypeDoc configuration (entrypoint src/index.ts, output docs/, excludes private/internal/external symbols). |
| package.json | Adds docs script and typedoc dev dependency. |
| package-lock.json | Locks TypeDoc and its transitive dependencies. |
| .gitignore | Ignores generated docs/ output. |
| .github/workflows/pr-validation.yml | Runs npm run docs as part of the existing quality job. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Hector Hernandez (hectorhdzg)
merged commit Apr 20, 2026
4610626
into
microsoft:main
9 checks passed
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.