Как редактировать и добавлять гайды
Все содержимое сайта находится в docs/ и написано в Markdown. Бэкенда и базы данных у сайта нет.
Изменить существующий гайд
- Откройте нужный
.mdвdocs/guides/. - Измените текст, сохраняя технические имена полей в обратных кавычках.
- Проверьте ссылки и сборку:
bash
.venv/bin/python scripts/build.py
- Откройте
dist/index.htmlи нужную страницу изdist/guides/. - Закоммитьте исходный Markdown и обновлённый
dist/.
Добавить новый гайд
Создайте docs/guides/короткое-имя.md со структурой:
# Название таблицы
## Назначение и границы
## Поток данных
## Гранулярность строки
## Сводная таблица колонок
## Подробное описание каждой колонки
## Сквозной пример
## Ограничения и диагностика
## Где менять код
Затем добавьте страницу в mkdocs.yml:
nav:
- Главная: index.md
- Гайды:
- Яндекс Маркет — таблица заказов: guides/yandex-market-orders.md
- Новый гайд: guides/короткое-имя.md
Чек-лист качества
- список колонок получен из UI-кода, а не составлен по памяти;
- описаны все колонки режима «показать всё»;
- для прямого поля указаны схема, таблица и столбец;
- для отчёта указаны название отчёта, лист и поле/позиция;
- для вычисления приведены формула, fallback и пример;
- указано, относится сумма к заказу, позиции или единице товара;
- возвраты, отмены, пустые значения и дубли рассмотрены явно;
- реальные данные получены read-only запросом;
- дата проверки и версии/ветки источников зафиксированы;
- строгая сборка проходит,
dist/index.htmlсуществует.