-
Notifications
You must be signed in to change notification settings - Fork 27
Open
Labels
Feature RequestNew feature or requestNew feature or requestdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
Add comprehensive API documentation using TypeDoc and publish to GitHub Pages.
Implementation
- Install and configure TypeDoc
- Generate API reference from TypeScript source
- Publish to GitHub Pages
- Add to CI/CD pipeline
Tasks
- Add typedoc as dev dependency
- Configure typedoc.json
- Add npm script:
docs:generate
- Set up GitHub Pages deployment
- Add docs generation to CI
- Add documentation badge to README
- Link from main README
Scripts to Add
{
"scripts": {
"docs:generate": "typedoc src/index.ts",
"docs:serve": "typedoc --watch src/index.ts"
}
}
GitHub Pages
- Deploy from gh-pages branch
- Auto-update on releases
- Custom domain (optional)
Documentation Sections
- Tool API reference
- Configuration options
- Transport interfaces
- Type definitions
Metadata
Metadata
Assignees
Labels
Feature RequestNew feature or requestNew feature or requestdocumentationImprovements or additions to documentationImprovements or additions to documentation