Skip to content

README.md

Latest commit

 

History

History
90 lines (69 loc) · 3.82 KB

README.md

File metadata and controls

90 lines (69 loc) · 3.82 KB

ZeroClaw Docs Structure Map

This page defines the canonical documentation layout and compatibility layers.

Last refreshed: February 24, 2026.

Companion indexes:

1) Directory Spine (Canonical)

Layer A: global entry points

  • Root product landing: README.md (language switch links into docs/i18n/<locale>/README.md)
  • Docs hub: docs/README.md
  • Unified TOC: docs/SUMMARY.md

Layer B: category collections (English source-of-truth)

  • docs/getting-started/
  • docs/reference/
  • docs/operations/
  • docs/security/
  • docs/hardware/
  • docs/contributing/
  • docs/project/
  • docs/sop/

Layer C: canonical locale trees

  • docs/i18n/zh-CN/
  • docs/i18n/ja/
  • docs/i18n/ru/
  • docs/i18n/fr/
  • docs/i18n/vi/
  • docs/i18n/el/

Layer D: compatibility shims (non-canonical)

  • docs/SUMMARY.<locale>.md (if retained)
  • docs/vi/**
  • legacy localized docs-root files where present

Use compatibility paths for backward links only. New localized edits should target docs/i18n/<locale>/**.

2) Language Topology

Locale Root landing Canonical docs hub Coverage level Notes
en README.md docs/README.md Full source Authoritative runtime-contract wording
zh-CN docs/i18n/zh-CN/README.md docs/i18n/zh-CN/README.md Hub-level scaffold Runtime-contract docs mainly shared in English
ja docs/i18n/ja/README.md docs/i18n/ja/README.md Hub-level scaffold Runtime-contract docs mainly shared in English
ru docs/i18n/ru/README.md docs/i18n/ru/README.md Hub-level scaffold Runtime-contract docs mainly shared in English
fr docs/i18n/fr/README.md docs/i18n/fr/README.md Hub-level scaffold Runtime-contract docs mainly shared in English
vi docs/i18n/vi/README.md docs/i18n/vi/README.md Full localized tree docs/vi/** kept as compatibility layer
el docs/i18n/el/README.md docs/i18n/el/README.md Full localized tree Greek full tree is canonical in docs/i18n/el/**

3) Category Intent Map

Category Canonical index Intent
Getting Started docs/getting-started/README.md first-run and install flows
Reference docs/reference/README.md commands/config/providers/channels and integration references
Operations docs/operations/README.md day-2 operations, release, troubleshooting runbooks
Security docs/security/README.md current hardening guidance + proposal boundary
Hardware docs/hardware/README.md boards, peripherals, datasheets navigation
Contributing docs/contributing/README.md PR/review/CI policy and process
Project docs/project/README.md time-bound snapshots and planning audit history
SOP docs/sop/README.md SOP runtime contract and procedure docs

4) Placement Rules

  1. Runtime behavior docs go in English canonical paths first.
  2. Every new major doc must be linked from:
  • the nearest category index (docs/<category>/README.md)
  • docs/SUMMARY.md
  • docs/docs-inventory.md
  1. Locale navigation changes must update all supported locales (en, zh-CN, ja, ru, fr, vi, el).
  2. For localized hubs/summaries, canonical path is always docs/i18n/<locale>/.
  3. Keep compatibility shims aligned when touched; do not introduce new primary content under compatibility-only paths.

5) Governance Links