S.Gromov
4cea1007ed
- добавлен раздел о применении SLM в монорепозиториях - обновлена навигация документации и обзор архитектуры - обновлены сгенерированные артефакты документации
32 lines
2.2 KiB
Markdown
32 lines
2.2 KiB
Markdown
---
|
||
title: Документация
|
||
---
|
||
|
||
# Документация
|
||
|
||
Раздел помогает быстро найти нужное правило SLM Design. Здесь собраны маршруты чтения, карта разделов и ссылки на материалы для AI-ассистентов.
|
||
|
||
## С чего начать
|
||
|
||
- Если вы знакомитесь с подходом впервые — начните с [SLM Design](/architecture/).
|
||
- Если проектируете структуру `src/` — откройте [Слои](/architecture/layers).
|
||
- Если создаёте новый домен или блок интерфейса — используйте [Модули](/architecture/modules).
|
||
- Если выбираете папку внутри модуля — смотрите [Сегменты](/architecture/segments).
|
||
- Если адаптируете SLM к монорепозиторию — откройте [Монорепозитории](/architecture/monorepo).
|
||
|
||
## Разделы
|
||
|
||
| Раздел | Когда открывать |
|
||
|--------|----------------|
|
||
| [SLM Design](/architecture/) | Нужно понять общую идею архитектуры и контекст правил. |
|
||
| [Слои](/architecture/layers) | Нужно определить, где должен жить код и какие зависимости допустимы. |
|
||
| [Модули](/architecture/modules) | Нужно оформить границы модуля, публичный API или фабрику. |
|
||
| [Сегменты](/architecture/segments) | Нужно выбрать внутреннюю папку для компонента, хука, стиля, типа или конфига. |
|
||
| [Монорепозитории](/architecture/monorepo) | Нужно понять, что можно выносить в `packages/*` и какие слои остаются внутри приложения. |
|
||
|
||
## Для ассистентов
|
||
|
||
- `/llms.txt` — краткая карта документации.
|
||
- `/llms-full.txt` — полный контекст архитектуры.
|
||
- `/slm-design.zip` — архив Markdown-файлов.
|