WealthLedger/docs
5
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: reorganize system knowledge by domain

Browse Source
This commit is contained in:
ksv741
2026-09-12 14:45:42 +03:00
parent 3a99af1a6e
commit f20c3f47bc
83 changed files with 2229 additions and 7335 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+13 -10
View File
@@ -1,14 +1,17 @@
# Документация WealthLedger
Этот репозиторий описывает устройство системы, пользовательские возможности,
ограничения и причины принятых решений. [Главная страница](README.md) и
[тематический индекс](AI_INDEX.md) дают вход в эти знания без доступа к исходникам.
Перед изменением прочитай [README](README.md) и [CONTRIBUTING](CONTRIBUTING.md),
затем только затронутую тему. Docs объясняет систему; требования принадлежат
основным спецификациям, реализация и coding conventions — соседним репозиториям.
[Правила ведения документации](development/documentation.md) определяют
ответственность за актуальность, сохранение смысла и проверку самостоятельности.
Архитектурные решения сохраняются в ADR; аудиты и датированные свидетельства
остаются историческими материалами и не заменяют описание текущего поведения.
Проверь существенные факты адресно по спецификациям, ADR и реализации с учётом
веток и незакоммиченных изменений. Расхождение обозначь, не выбирая источник
победителем автоматически. Перенос сохраняет полезное содержание и входящие
ссылки; существующие исторические свидетельства остаются неизменными.
Отчёты аудитов и исследований в docs не размещаются. Подтверждённые решения
из исследований оформляются в ADR, системные знания — в тематических страницах.
Локальные проверки документации охватывают Markdown, относительные ссылки
и якоря; смысловая согласованность проверяется отдельно. Синтаксическая
проверка не гарантирует актуальность архитектурного или функционального факта.
Перед завершением проверь текст, диаграммы и маршруты чтения; выполни
[доступные проверки](CONTRIBUTING.md#проверки), включая новые файлы.
Сохрани границы задачи и чужие изменения. Успех Markdown-проверки не заменяет
смысловую сверку и не доказывает рендер диаграмм.