45 lines
2.5 KiB
Markdown
45 lines
2.5 KiB
Markdown
# Docs
|
|
|
|
## Назначение и authority
|
|
|
|
Этот репозиторий хранит durable as-built документацию WealthLedger. Shared SDD
|
|
policy, common reading pointers, audit routing и `../references/**` policy
|
|
задаёт root `AGENTS.md`.
|
|
|
|
Для SDD roles, approvals и ownership читайте
|
|
[governance](development/engineering-governance.md); native planning и completion
|
|
в store `wealth-ledger-specs` —
|
|
[lifecycle](development/openspec-authority-and-lifecycle.md); recovery, fingerprints
|
|
и evidence reuse — [context authority](development/agent-token-efficiency.md).
|
|
Audit-derived работа начинается с найденной записи
|
|
[remediation registry](development/audit-remediation.md). Optional agent adapters
|
|
не требуются.
|
|
|
|
Docs фиксирует проверенное as-built состояние. Planning и Completion Evidence
|
|
принадлежат canonical `../specs/openspec`; docs не хранит их параллельную копию.
|
|
|
|
## Canonical gate
|
|
|
|
Перед Node-командами активировать `.nvmrc` через `nvm use --silent`; это выбирает
|
|
Node 22. Не запускать отдельную проверку версии, кроме диагностики runtime issue.
|
|
После lockfile install:
|
|
|
|
```bash
|
|
npm ci
|
|
npm run verify
|
|
```
|
|
|
|
Gate non-mutating запускает committed Markdown rules и `git diff --check`. Auto-fix и network/browser link checking в gate не входят; local links affected documentation проверяются scoped review.
|
|
Актуальные scripts проверять в `package.json`/`npm run`.
|
|
|
|
## Boundaries
|
|
|
|
- `architecture/` — текущее устройство, `features/` — поставленное поведение,
|
|
`adr/` — устойчивые решения, `development/` — процесс и navigation к canonical
|
|
evidence, `audits/` — immutable snapshots. Legacy dated evidence не переписывается.
|
|
- Indexes должны вести к новым документам.
|
|
- Feature docs описывают фактический поток, API и ограничения, но не повторяют OpenSpec requirements/design/tasks.
|
|
- Для диаграмм использовать Mermaid в Markdown. Не хранить application code, secrets или competing SDD artifacts.
|
|
|
|
Markdown lint и whitespace checks — hard guardrails. Стилистические пожелания без локального checker являются guidance.
|