documentation-generator

To auto-generate API docs, the system analyzes TypeScript and JSDoc annotations to extract descriptions, parameters, and examples. This builds comprehensive API references directly from your codebase, ensuring documentation stays synchronized with implementation changes.

Generating a changelog from git history uses conventional commits to produce versioned sections and release notes. This automation captures code changes accurately, creating structured release documentation without manual entry or editing.

Creating user guides from a product spec assembles step-by-step instructions and troubleshooting tips automatically. This translates product specifications into user-facing documentation, providing clear guidance without manual writing.

Auto-generated documentation supports publishing via a docs site route configured in your deployment pipeline. The documentation rebuilds on every deploy, ensuring published guides and API references remain current with cross-links and versioning.

Keeping API references and user guides up-to-date requires automated rebuilds triggered on every deploy. By deriving documentation from code comments, type definitions, and git history, the system cross-links and publishes current docs automatically.