gromov/slm-design
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity
Files
1af27795edadf4296993a76aca36e22f386003ed
slm-design/AGENTS.md
S.Gromov d3a4f6a436 docs: переработать архитектуру SLM Design 
- переписана главная страница: преимущества, происхождение, принципы, структура проекта
- переработан справочник слоёв: business/infrastructure/ui вместо features/entities, группы слоёв (композиция/ядро/фундамент), параллельные layouts и screens, направление зависимостей, группировка при масштабировании
- заполнен справочник модулей: определение, модуль vs компонент, структура, публичный API, фабрика (DI), жизненный цикл
- заполнен справочник сегментов: 10 сегментов включая ui/, parts/, mappers/
- удалены заглушки guides/ и examples/, обновлён сайдбар и concat-md.js
- добавлена фильтрация rules-link при генерации RULES.md
2026-04-18 22:12:05 +03:00

1.6 KiB
Raw Blame History

Правила для агентов

При работе с документацией следовать правилам из CONTRIBUTING.md.

  • Язык документации и коммитов — русский.
  • После изменений в .md-файлах — запустить npm run docs для обновления RULES.md.
  • При добавлении нового раздела — обновить сайдбар (.vitepress/config.ts) и порядок файлов (concat-md.js).

Структура страницы документации

Каждая страница начинается одинаково:

  1. Заголовок (h1) — совпадает с title из frontmatter.
  2. Описание раздела — 1–2 строки сразу после заголовка. Говорит, что это за раздел, какую информацию он описывает и что читатель в нём получит. Не про предмет раздела, а про сам раздел.
  3. Определение (## Определение) — для справочных страниц, посвящённых одному термину. Короткая формулировка жирным: что это за сущность и какую роль она играет. Идёт первым h2 после описания раздела.
  4. Контент — остальные h2-подразделы.

Правило применяется ко всем разделам документации без исключений.