Skip to content

feat: TypeDoc API docs + GitHub Pages deployment #370

@OneStepAt4time

Description

@OneStepAt4time

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.

  1. Invoke brainstorming skill to explore TypeDoc config options, plugin ecosystem, and GitHub Pages deploy strategies
  2. Invoke writing-plans skill to produce a structured implementation plan
  3. Get plan approved (quality gate: tsc + build + test green)
  4. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions