Contributing to UCCA Docs¶
Structure¶
This repository contains two documentation sites:
- docs-site/ →
docs.ucca.online— Technical reference (the how) - knowledge-site/ →
knowledge.ucca.online— Strategy and context (the why)
Adding Content¶
- Determine if your content is docs (reference, how-to, look-up) or knowledge (context, rationale, strategy)
- Find the appropriate section — every folder has an
index.mdexplaining what belongs there - Create your file in the right location
- Add it to the
nav:section of the appropriatemkdocs.yml - Build locally to verify:
cd docs-site && mkdocs serve
Rules¶
- Every folder has an index.md. Even if it just says "content coming."
- Documents don't cross boundaries. If it's about both architecture and a market, put it in architecture with a link.
- Session handovers become docs. Every dev session that produces work should update the relevant section.
- Archive, never delete. Superseded docs move to archive with a note about what replaced them.
- Surfaces own their own handover. Each surface has an index.md that serves as its living handover document.