docs(handbook): скелет путеводителя и человеческая шапка README
- Зачем:
- менти негде было понять с первого экрана, что перед ним и куда идти;
тикет #209 карты #206 открывает учебную документацию стенда.
- Что:
- создан docs/handbook/README.md: тропа чтения и пять аннотированных
будущих глав с временными ссылками на справочники.
- шапка README.md переписана для менти: четыре действия и ссылки на
путеводитель и уроки; в разделе «Документация» добавлены handbook и labs.
- в AGENTS.md добавлено правило имен для docs/handbook/.
- Проверка:
- команда проверки ссылок из тикета #209 — пустой вывод;
- git diff: операторские разделы README не тронуты.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
d1dc0dd7bf
commit
ab35560ece
3 files changed
+64
-1
No files matched your search
@@ -161,6 +161,10 @@ Airflow) и названия из кода. Если для понятия ес
|
||||
(`top-pages-daily.md`), индекс папки — `README.md`. Здесь живут ТЗ учебных
|
||||
заданий. Ни даты, ни номера: задание — не событие истории, а живой документ,
|
||||
и правится он вместе с тем, о чем говорит. Слаг называет предмет задания.
|
||||
- Имена файлов в `docs/handbook/` — слаг строчными латинскими буквами через
|
||||
дефис, индекс папки — `README.md`. Здесь живет путеводитель по стенду:
|
||||
учебные главы для менти. Ни дат, ни номеров: глава — живой документ и
|
||||
правится вместе с тем, что описывает.
|
||||
- Имена файлов в `docs/adr/` — `NNNN-краткое-имя.md`: сквозной номер из четырёх
|
||||
цифр и слаг (`0001-stand-services.md`). Решения нумеруются подряд, дата
|
||||
в имени не нужна.
|
||||
|
||||
Reference in new issue
Block a user