Part 6: Generate Documentation
You have 3 annotated TypeScript files with rich metadata and relationships. Now you will generate living documentation from these annotations.
6.1 Generate the Pattern Registry
Section titled “6.1 Generate the Pattern Registry”npm run docs:patternsUsing sources from delivery-process.config.ts...Scanning source files... Found 6 patternsExtracting patterns... Extracted 6 patterns
Running generator: patterns ✓ PATTERNS.md ✓ patterns/user-service.md ✓ patterns/user-record.md ✓ patterns/event-store.md ✓ patterns/domain-event.md ✓ patterns/auth-handler.md ✓ patterns/auth-result.md
✅ Documentation generation complete! 7 files writtenPATTERNS.md is the pattern registry — an index of all patterns with:
- Progress bar and status counts (completed / active / planned)
- Categorized listing (API, Core, Infra, Shape)
- Brief descriptions from
@libar-docs-brief - A Mermaid dependency graph showing
uses(solid),depends-on(dashed), andimplements(dotted) relationships
patterns/*.md are per-pattern detail pages with:
- Status, category, phase, quarter metadata table
- Description from JSDoc markdown
- Use cases from
@libar-docs-usecasetags - Dependencies list
6.2 Generate the Roadmap
Section titled “6.2 Generate the Roadmap”npm run docs:roadmapUsing sources from delivery-process.config.ts...Scanning source files... Found 6 patternsExtracting patterns... Extracted 6 patterns
Running generator: roadmap ✓ ROADMAP.md ✓ phases/phase-01-inception.md ✓ phases/phase-02-elaboration.md ✓ phases/phase-03-session.md
✅ Documentation generation complete! 4 files writtenROADMAP.md organizes patterns by phase with:
- Overall progress bar and metrics
- Phase navigation table with per-phase completion percentages
- Per-phase sections listing patterns with descriptions
Phase names come from the default 6-phase-standard workflow: Inception, Elaboration, Session, Construction, Validation, Retrospective. Patterns are assigned to phases via @libar-docs-phase N.
Checkpoint: Part 6
Section titled “Checkpoint: Part 6”docs-generated/PATTERNS.mdexists with a Mermaid dependency graphdocs-generated/patterns/has individual pattern detail pagesdocs-generated/ROADMAP.mdexists with phase sectionsdocs-generated/phases/has phase detail pages
Recap: Part 6
Section titled “Recap: Part 6”patternsgenerator -> registry index + per-pattern detail pagesroadmapgenerator -> phase-based roadmap + per-phase detail pages- All content is derived from your annotations — change the code, regenerate, docs update