Files
docs/AGENTS.md
T

2.3 KiB

Docs

Назначение и authority

Этот репозиторий хранит durable as-built документацию WealthLedger. Shared SDD policy, common reading pointers, audit routing и ../references/** policy задаёт root AGENTS.md.

Canonical SDD authority находится в wealth-ledger-specs, физически в ../specs/openspec от этого репозитория. Любая OpenSpec command, читающая или изменяющая change, должна использовать --store wealth-ledger-specs.

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. Актуальные scripts проверять в package.json/npm run.

Boundaries

  • architecture/ — текущее устройство, features/ — поставленное поведение, adr/ — устойчивые решения, development/ — процесс и Completion Evidence, audits/ — immutable snapshots.
  • Indexes должны вести к новым документам.
  • Feature docs описывают фактический поток, API и ограничения, но не повторяют OpenSpec requirements/design/tasks.
  • Для диаграмм использовать Mermaid в Markdown. Не хранить application code, secrets или competing SDD artifacts.

Markdown lint и whitespace checks — hard guardrails. Стилистические пожелания без локального checker являются guidance.