Skip to content

Build SDK comprehensive documentation generator #144

@Kingsman-99

Description

@Kingsman-99

Label: complexity: high
Points: 200

Description

The SDK lacks auto-generated API documentation. This issue adds a scripts/generate-docs.ts script that parses TypeScript source files, extracts JSDoc comments, and generates a structured docs/API.md file covering all exported functions, classes, and types.

Technical Context

Involves a new scripts/generate-docs.ts. Use TypeScript compiler API (ts.createProgram) to parse src/index.ts and traverse exported declarations. Extract JSDoc tags (@param, @returns, @example). Generate Markdown with one section per export. Add npm run docs to package.json.

Acceptance Criteria

  • npm run docs generates docs/API.md
  • Every exported function documented with signature and description
  • @param and @returns tags rendered as parameter tables
  • @example blocks rendered as fenced code blocks
  • Generated docs include all 125 issue-related exports
  • All existing tests pass
  • TypeScript strict mode — zero any types

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions