Skip to main content

​
Contributing Docs

​
Where to put new docs

  • docs/runbooks/ for operational procedures
  • docs/reference/ for contracts/specs/proofs
  • docs/guides/ for how-tos and implementation notes
Use DOCS_INDEX and DOCS_SPINE to confirm placement.

​
Naming conventions

  • Use clear, specific filenames in UPPER_SNAKE_CASE.md for existing style alignment inside section folders
  • Prefer concise titles focused on intent (what to run, prove, or fix)
  • Avoid ambiguous names like notes.md or temp.md

​
Update navigation

When adding a doc, register it in docs/docs.json under the correct top-level group and subgroup.

​
Local preview

cd docs
npx mint dev

​
Doc quality checklist

  • Short intro + clear purpose
  • Skimmable sections with bullets
  • Link to related runbook/reference/guide docs
  • No stale or broken local links
  • MDX-safe syntax (backticks for code-like inline text)

​
No-go list

  • Do not include secrets, tokens, or credentials
  • Do not edit docs/archive/* or docs/_audit/* in normal doc updates
  • Do not move/delete docs unless explicitly requested