|
| 1 | +--- |
| 2 | +# Documentation Review Configuration |
| 3 | +# Generated by /doc-setup on 2026-02-22 |
| 4 | + |
| 5 | +doc_paths: |
| 6 | + - spec/specification.md |
| 7 | + - spec/assistant-adoption.md |
| 8 | + - spec/schemas/assistant-adoption.schema.json |
| 9 | + - spec/schemas/manifest.schema.json |
| 10 | + - spec/assistants/*.json |
| 11 | + - src/content/docs/**/*.mdx |
| 12 | + - docs/plans/*.md |
| 13 | + - blog/*.md |
| 14 | + |
| 15 | +ignore: |
| 16 | + - node_modules/ |
| 17 | + - dist/ |
| 18 | + - .astro/ |
| 19 | + - "*.lock" |
| 20 | + - "*.min.*" |
| 21 | + |
| 22 | +standards: |
| 23 | + require_description: true |
| 24 | + max_heading_depth: 4 |
| 25 | + require_code_examples: true |
| 26 | + check_links: true |
| 27 | + check_spelling: true |
| 28 | + strictness: strict |
| 29 | + |
| 30 | +cross_validation: |
| 31 | + spec_to_astro_sync: true |
| 32 | + sync_pairs: |
| 33 | + - source: spec/specification.md |
| 34 | + targets: |
| 35 | + - src/content/docs/specification/overview.mdx |
| 36 | + - src/content/docs/specification/archive-format.mdx |
| 37 | + - src/content/docs/specification/manifest.mdx |
| 38 | + - src/content/docs/specification/component-types.mdx |
| 39 | + - src/content/docs/specification/install-lifecycle.mdx |
| 40 | + - src/content/docs/specification/lockfile.mdx |
| 41 | + - src/content/docs/specification/portability.mdx |
| 42 | + - src/content/docs/specification/lazy-loading.mdx |
| 43 | + - src/content/docs/specification/appendices.mdx |
| 44 | + - source: spec/assistants/*.json |
| 45 | + targets: |
| 46 | + - src/content/docs/assistants/*.mdx |
| 47 | + schema_prose_validation: true |
| 48 | + schema_pairs: |
| 49 | + - schema: spec/schemas/manifest.schema.json |
| 50 | + prose: spec/specification.md |
| 51 | + - schema: spec/schemas/assistant-adoption.schema.json |
| 52 | + prose: spec/assistant-adoption.md |
| 53 | + |
| 54 | +site_generator: |
| 55 | + type: astro-starlight |
| 56 | + config_path: astro.config.mjs |
| 57 | + |
| 58 | +api_docs: |
| 59 | + openapi_path: null |
| 60 | + asyncapi_path: null |
| 61 | + generate_from_code: false |
| 62 | + |
| 63 | +output: |
| 64 | + verbosity: detailed |
| 65 | + format: markdown |
| 66 | +--- |
| 67 | + |
| 68 | +# Project Documentation Notes |
| 69 | + |
| 70 | +## Architecture |
| 71 | + |
| 72 | +ccpkg documentation follows a three-layer pattern: |
| 73 | + |
| 74 | +1. **Canonical source**: `spec/specification.md` and `spec/assistant-adoption.md` are the normative specs. All prose authority lives here. |
| 75 | +2. **JSON schemas**: `spec/schemas/*.json` provide machine validation. Properties and types must match the prose spec. |
| 76 | +3. **Astro site**: `src/content/docs/` pages are generated/synced from canonical specs via `scripts/generate-spec-pages.mjs` and `scripts/generate-assistant-pages.mjs`. These should never diverge from the canonical source. |
| 77 | + |
| 78 | +## Generated files (review for freshness, not authoring) |
| 79 | + |
| 80 | +- `src/content/docs/assistants/*.mdx` — generated by `npm run generate:assistants` from `spec/assistants/*.json` |
| 81 | +- `src/content/docs/specification/*.mdx` — synced from `spec/specification.md` sections |
| 82 | + |
| 83 | +## MDX Compatibility |
| 84 | + |
| 85 | +Angle brackets (`<`, `>`) in spec markdown must be escaped as `<`/`>` for MDX compatibility, even inside code blocks within numbered lists. |
| 86 | + |
| 87 | +## Review priorities |
| 88 | + |
| 89 | +1. Spec-schema consistency: Do JSON schema fields match what the prose documents? |
| 90 | +2. Spec-Astro sync: Have Astro pages been regenerated after spec changes? |
| 91 | +3. Cross-references: Do internal links between spec sections resolve correctly? |
| 92 | +4. Data accuracy: Do assistant adoption specs match official host documentation? |
0 commit comments