Repository navigation
v1.0.0-pre.2
Pre-release
Pre-release
Documentation Consolidation
Replaces manually maintained documentation with auto-generated equivalents driven by annotated source code. Establishes docs-live/ as the single output directory, builds 5 new generation codecs, and reduces manual doc maintenance by ~900 lines.
67 commits across 184 files (+22,184 / -5,442 lines)
Highlights
- Unified output directory — all generated docs now go to
docs-live/(57+ files).docs-generated/eliminated from tracking. - 5 new codecs — IndexCodec, CliRecipeGenerator, ProcessApiReferenceGenerator, ClaudeModuleCodec, Architecture generator
- Declarative CLI schema —
src/cli/cli-schema.tsis the single source of truth for both runtime help text and generated reference docs - Session workflows as queryable rules — 7 Rule blocks in
session-guides-module-source.featurereplace hand-authored CLAUDE.md session content loadPreambleFromMarkdown()— editorial content authored as Markdown indocs-sources/, parsed into structured blocks at config time, reducing per-codec config boilerplate by ~540 lines
Manual Docs Impact
| Document | Reduction | Generated Replacement |
|---|---|---|
| PROCESS-API.md | 87% | PROCESS-API-REFERENCE.md + PROCESS-API-RECIPES.md |
| README.md | 72% | Website components + docs-live/INDEX.md hub |
| CLAUDE.md | 38% | Process Data API queries |
| GHERKIN-PATTERNS.md | 29% | Step Linting → VALIDATION.md |
New Generated Output
| Generator | Output | Lines |
|---|---|---|
| IndexCodec | docs-live/INDEX.md |
226 |
| CliRecipeGenerator | PROCESS-API-RECIPES.md |
476 |
| ProcessApiReferenceGenerator | PROCESS-API-REFERENCE.md |
63 |
| Architecture generator | ARCHITECTURE.md |
564 |
| Changelog generator | CHANGELOG-GENERATED.md |
328 |
Plus 4 new reference documents: PROCESS-GUARD-REFERENCE.md, SESSION-WORKFLOW-GUIDE.md, ANNOTATION-REFERENCE.md, and enhanced ARCHITECTURE-CODECS.md / ARCHITECTURE-TYPES.md.
Test Coverage
14 new test files (+2,524 lines), all Gherkin .feature + step definitions. Full suite: 4,637 tests passing.
Related: #32
Full Changelog: v1.0.0-pre.1...v1.0.0-pre.2