Skip to content

Repository Layout

Top-Level Files

  • mkdocs.yml: site configuration and navigation
  • requirements.txt: Python dependencies
  • README.md: install, serve, and build instructions
  • docs/: all handbook content

Content Areas

  • docs/architecture/: system and flow diagrams
  • docs/smart-contracts/: contract inventory and behavior
  • docs/governance/: role model, timelocks, upgrade safety
  • docs/deposits/, docs/vaults/, docs/economics/, docs/claims/: execution model
  • docs/security/: threat and catastrophic-risk analysis
  • docs/operations/ and docs/runbooks/: operator procedures
  • docs/state-machines/: lifecycle models
  • docs/appendices/: permission matrix and source mapping

Generated And Local Files

site/, .venv/, __pycache__/, .DS_Store, and __MACOSX/ are local artifacts and should not be committed. The Solidity inventory is regenerated by tools/extract_solidity_inventory.py and checked into docs/appendices/generated-solidity-inventory.md because it is a review aid.

Source Boundary

The handbook repo is documentation. The current Solidity source of truth lives outside this repo at /Users/marcos/Desktop/centurion_phase1_upgradeable_refactor. When source changes, update the generated inventory and the human-written pages together.