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
Label: complexity: high
Points: 200
Description
The SDK lacks auto-generated API documentation. This issue adds a
scripts/generate-docs.tsscript that parses TypeScript source files, extracts JSDoc comments, and generates a structureddocs/API.mdfile covering all exported functions, classes, and types.Technical Context
Involves a new
scripts/generate-docs.ts. Use TypeScript compiler API (ts.createProgram) to parsesrc/index.tsand traverse exported declarations. Extract JSDoc tags (@param,@returns,@example). Generate Markdown with one section per export. Addnpm run docstopackage.json.Acceptance Criteria
npm run docsgeneratesdocs/API.md@paramand@returnstags rendered as parameter tables@exampleblocks rendered as fenced code blocksanytypes