Feature Request — API Documentation (TypeDoc + GitHub Pages)
Context
Aegis has no public API documentation. With declaration: true already in tsconfig, TypeDoc can generate full API docs from TSDoc comments with minimal setup.
What to build
- Install and configure
typedoc as devDependency
- Add TSDoc comments (
/** @param ... @returns ... */) to all public API methods in src/
- Generate HTML docs into
docs/api/
- Deploy to GitHub Pages on every push to main
Acceptance criteria
npm run docs generates docs/api/ without errors
- All public methods in
src/server.ts, src/session.ts, src/cli.ts have TSDoc coverage
- GitHub Pages live at
https://onestepat4time.github.io/aegis/
- No CI regression
How to approach
⚠️ Use plan mode + brainstorming skill before writing any code.
- Invoke
brainstorming skill to explore TypeDoc config options, plugin ecosystem, and GitHub Pages deploy strategies
- Invoke
writing-plans skill to produce a structured implementation plan
- Get plan approved (quality gate: tsc + build + test green)
- Only then implement via
executing-plans skill
Notes
sourceMap: true in tsconfig → source maps currently bundled. Consider tsconfig.build.json override with sourceMap: false for production build — evaluate in brainstorming phase.
- TypeDoc plugins worth evaluating:
typedoc-plugin-markdown, typedoc-plugin-mdn-links
Feature Request — API Documentation (TypeDoc + GitHub Pages)
Context
Aegis has no public API documentation. With
declaration: truealready in tsconfig, TypeDoc can generate full API docs from TSDoc comments with minimal setup.What to build
typedocas devDependency/** @param ... @returns ... */) to all public API methods insrc/docs/api/Acceptance criteria
npm run docsgeneratesdocs/api/without errorssrc/server.ts,src/session.ts,src/cli.tshave TSDoc coveragehttps://onestepat4time.github.io/aegis/How to approach
Notes
sourceMap: truein tsconfig → source maps currently bundled. Considertsconfig.build.jsonoverride withsourceMap: falsefor production build — evaluate in brainstorming phase.typedoc-plugin-markdown,typedoc-plugin-mdn-links