Documentation Structure
To keep documentation maintainable, CHX uses two separate doc surfaces:
Public Documentation (this site)
Section titled “Public Documentation (this site)”Location: apps/docs/src/content/docs
Contains:
- End-user guides
- CLI and configuration reference
- Plugin usage documentation
- Operational usage and troubleshooting
Rules:
- Audience is users of CHX
- Prefer stable, task-oriented content
- Avoid roadmap and speculative details
Internal Planning
Section titled “Internal Planning”Location: planning/
Contains:
- Deferred feature specs
- Internal architecture notes
- Reference contracts (JSON output, internal structure)
Rules:
- Audience is maintainers/contributors
- Can include in-progress ideas and execution notes
- Not published in the public docs app
Rule of Thumb
Section titled “Rule of Thumb”If a page answers “How do I use CHX?”, it belongs in public docs. If a page answers “How are we planning/building CHX internally?”, it belongs in planning.