Local Development & Contribution Workflow
This document outlines the day-to-day development workflow for contributing canonical documentation, creating derived templates, and running local tests.
Running the Dev Server
Start Docusaurus with hot reloading:
npm start
The site will be available at http://localhost:3000/doCCAD_pre/.
Authoring Canonical Documentation
When adding or updating a canonical document:
- Place the file under
docs/source/<category>/<slug>.md. - Ensure required frontmatter fields are complete:
id,title,type: canonical,audience,owners,sources, andlast_validated. - Set
ai_generation.allowed: trueif this document is admissible as evidence for derived views. - Run validation before opening a PR:
npm run validate
Contribution Principles
- Preserve Before Modifying: Historical decisions and rationale should be superseded via new ADRs rather than silently deleted.
- Never Commit Secrets: API keys, credentials, and tokens must never appear in files or context payloads. Use
.env.example. - Maintain Plane Integrity: Do not place generated content in
docs/source/.