Skip to content

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

  1. Determine if your content is docs (reference, how-to, look-up) or knowledge (context, rationale, strategy)
  2. Find the appropriate section — every folder has an index.md explaining what belongs there
  3. Create your file in the right location
  4. Add it to the nav: section of the appropriate mkdocs.yml
  5. Build locally to verify: cd docs-site && mkdocs serve

Rules

  1. Every folder has an index.md. Even if it just says "content coming."
  2. Documents don't cross boundaries. If it's about both architecture and a market, put it in architecture with a link.
  3. Session handovers become docs. Every dev session that produces work should update the relevant section.
  4. Archive, never delete. Superseded docs move to archive with a note about what replaced them.
  5. Surfaces own their own handover. Each surface has an index.md that serves as its living handover document.