Skip to content

Add TypeDoc for API documentation generation - #24

Merged
Hector Hernandez (hectorhdzg) merged 1 commit into
microsoft:mainfrom
hectorhdzg:hectorhdzg/add-typedoc
Apr 20, 2026
Merged

Hector Hernandez (hectorhdzg) merged 1 commit into
microsoft:mainfrom
hectorhdzg:hectorhdzg/add-typedoc

Conversation

@hectorhdzg

Copy link
Copy Markdown
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)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 typedoc as a dev dependency and a typedoc.json config targeting src/index.ts.
  • Add npm run docs to generate HTML docs into docs/.
  • 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.

@hectorhdzg
Hector Hernandez (hectorhdzg) merged commit 4610626 into microsoft:main Apr 20, 2026
9 checks passed
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.

4 participants