docs(labs): факультативы вынесены в отдельную папку
- Зачем: - расположение файла должно отличать задания основной программы от факультативов. - Что: - существующее ТЗ Superset перенесено в `docs/labs/optional/`, ссылки обновлены. - правило размещения записано в `AGENTS.md`. - выбор формы витрин объяснен учебной целью стенда. - Проверка: - `git diff --check`. - проверены все упоминания `superset-dashboard` и относительные ссылки.
This commit is contained in:
1 parent
1671e67813
commit
f0c7fe0c74
6 files changed
+23
-22
No files matched your search
@@ -157,14 +157,15 @@ Airflow) и названия из кода. Если для понятия ес
|
||||
дефис (`clickstream-event.md`). Ни даты, ни номера: документ не событие
|
||||
истории, а текущее описание живого формата — и собирается из кода, а не
|
||||
пишется руками.
|
||||
- Имена файлов в `docs/labs/` — `S-N-slug.md`: номер ступени, номер задания
|
||||
внутри ступени и слаг строчными латинскими буквами через дефис
|
||||
(`1-2-top-pages-daily.md`), индекс папки — `README.md`. Здесь живут ТЗ
|
||||
- Имена файлов основной программы в `docs/labs/` — `S-N-slug.md`:
|
||||
номер ступени, номер задания внутри ступени и слаг строчными латинскими
|
||||
буквами через дефис (`1-2-top-pages-daily.md`). Здесь живут ТЗ
|
||||
учебных заданий. Номера повторяют порядок программы из `README.md`, чтобы
|
||||
папка читалась как оглавление; даты нет: задание — живой документ и
|
||||
правится вместе с тем, о чем говорит. Слаг называет предмет задания.
|
||||
Факультативы порядка не имеют и живут под одним слагом
|
||||
(`superset-dashboard.md`).
|
||||
Факультативы живут в `docs/labs/optional/`, без номеров, под одним слагом
|
||||
(`superset-dashboard.md`). Общий индекс обеих частей — `docs/labs/README.md`;
|
||||
отдельного индекса в `optional/` нет.
|
||||
- Имена файлов в `docs/handbook/` — слаг строчными латинскими буквами через
|
||||
дефис, индекс папки — `README.md`. Здесь живет путеводитель по стенду:
|
||||
учебные главы для менти. Ни дат, ни номеров: глава — живой документ и
|
||||
|
||||
Reference in new issue
Block a user