mirror of
https://github.com/Ku6epXBOCTuK/easy-png-tools.git
synced 2026-11-13 17:08:20 +00:00
docs: review all
This commit is contained in:
+4
-3
@@ -15,6 +15,7 @@
|
||||
| Документ | Когда читать | Статус |
|
||||
| ---------------------------------- | -------------------------------------------------- | ------ |
|
||||
| `AGENTS.md` | Всегда: контракт агента | active |
|
||||
| `docs/README.md` | Индекс документов, правила ведения документации | active |
|
||||
| `docs/architecture.md` | Слои, поток данных, новый инструмент/поле/маршрут | active |
|
||||
| `docs/quality-gates.md` | Какие проверки запускать, пороги, coverage, CI | active |
|
||||
| `docs/decisions.md` | Правка самих гейтов; чтение CI после пуша | active |
|
||||
@@ -60,9 +61,9 @@
|
||||
`web/src/lib/registry/tools/`, адрес и имя страницы (`slug`) — в
|
||||
`web/src/lib/registry/pages/`; исторические названия в старых планах не
|
||||
действуют (`docs/architecture.md`, раздел 3).
|
||||
- Поиск по `docs/` задевает `docs/archive/` (объём больше, чем у активных
|
||||
документов вместе). Для правок production-кода архив не нужен: grep по
|
||||
`docs/*.md` без `archive/`.
|
||||
- Поиск по `docs/` задевает `docs/archive/`: там вынесены завершённые планы и
|
||||
исследования, поэтому grep по `docs/` даёт больше шума, чем пользы. Для правок
|
||||
production-кода архив не нужен: grep по `docs/*.md` без `archive/`.
|
||||
- Проверка ссылок в документации не автоматизирована; ожидаемо неразрешимыми
|
||||
считаются ссылки на `docs/plan-domain.local.md` (файл вне git). Всё остальное
|
||||
неразрешимое — ошибка.
|
||||
|
||||
Reference in New Issue
Block a user