Getting Started Guides
Practical walkthroughs for setting up docsgen in different project configurations. Each guide takes you from zero to working documentation with real examples.
- Learn by doing - Follow step-by-step walkthroughs instead of reading reference tables.
- See real output - Each guide shows what the generated documentation actually looks like.
- Pick your setup - Choose the guide that matches your project structure.
Available Guides
Documenting a Single Package
End-to-end walkthrough: install docsgen, configure it for one TypeScript package, add JSDoc comments, build, and
see the generated API docs. Includes setting up the @import directive to embed live API fragments in hand-written
guides.
Best for: First-time users, single-package libraries, learning the basics.
Monorepo Documentation
Set up docsgen for a monorepo with multiple packages. Covers dynamic package discovery, per-package configuration, cross-package type linking, and sidebar organization.
Best for: Monorepo maintainers, multi-package libraries, Nx/Turborepo/Lerna users.
If you are looking for reference documentation rather than guides, see:
- Installation for system requirements and install commands.
- Configuration for the complete options reference.
- Quick Start for a minimal setup in under 5 minutes.
