2.4 KiB
Docs
Назначение и authority
Этот репозиторий хранит durable as-built документацию WealthLedger. Canonical OpenSpec store — wealth-ledger-specs в ../specs/openspec; OpenSpec commands, читающие или изменяющие change, всегда выполняются с --store wealth-ledger-specs. Proposal, Delta Specs, Design, Tasks и другие versioned planning artifacts вне canonical store запрещены, включая superpowers/plans; ../references/** read-only.
Docs обновляется до фактического проверенного состояния affected change и не представляет planned behavior как поставленное. Artifact ownership и Completion Evidence определены в development/engineering-governance.md; audit-derived работа начинается с development/audit-remediation.md.
Canonical gate
Node 22 обязателен. После lockfile install:
npm ci
npm run verify
Gate non-mutating и запускает runtime preflight, committed Markdown rules и git diff --check. Auto-fix и network/browser link checking в gate не входят; local links affected documentation проверяются scoped review.
Boundaries
architecture/— текущее устройство,features/— поставленное поведение,adr/— устойчивые решения,development/— процесс и Completion Evidence,audits/— immutable snapshots.- Перед изменением current state сверяться с
architecture/system-overview.mdиarchitecture/domain-glossary.md; indexes должны вести к новым документам. - Feature docs описывают фактический поток, API и ограничения, но не повторяют OpenSpec requirements/design/tasks.
- Для диаграмм использовать Mermaid в Markdown. Не хранить application code, secrets или competing SDD artifacts.
Markdown lint и whitespace checks — hard guardrails. Стилистические пожелания без локального checker являются guidance.