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
@@ -1,8 +1,15 @@
|
||||
# Учебная дата-платформа кликстрима
|
||||
|
||||
Стенд для работы с кликстримом. Преемник учебного стенда
|
||||
Этот стенд — для менти, который видит такую систему впервые и хочет
|
||||
проследить весь путь данных: от кликстрима и заказов до витрин, проверок и
|
||||
графиков. Преемник учебного стенда
|
||||
[clickstream-ch-kafka-superset-demo](https://git.dementev.space/ddmitry/clickstream-ch-kafka-superset-demo).
|
||||
|
||||
Поднять стенд поможет [«Быстрый старт»](#быстрый-старт), выключить —
|
||||
`make down`. Чтобы разобраться в устройстве, начните с
|
||||
[путеводителя](docs/handbook/README.md), а учиться — с
|
||||
[уроков](docs/labs/README.md).
|
||||
|
||||
## Статус
|
||||
|
||||
Репозиторий строится по спеке
|
||||
@@ -410,6 +417,9 @@ Superset закреплён на 6.1.0; драйвер `clickhouse-connect`, ф
|
||||
|
||||
## Документация
|
||||
|
||||
- [docs/handbook/](docs/handbook/) — путеводитель по стенду и порядок чтения.
|
||||
- [docs/labs/](docs/labs/) — учебные задания с порядком прохождения и
|
||||
самопроверкой.
|
||||
- [docs/specs/](docs/specs/) — спеки: источник истины о задуманном.
|
||||
- [docs/adr/](docs/adr/) — принятые решения с доводами и отвергнутыми
|
||||
вариантами: почему сделано так, а не иначе.
|
||||
|
||||
Reference in new issue
Block a user