gromov/slm-design
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity
Files
4cea1007ede79da29b32ef18733b146044a87e4f
slm-design/docs/index.md
S.Gromov 4cea1007ed
All checks were successful
CI/CD Pipeline / build (push) Successful in 18s
Details
CI/CD Pipeline / version (push) Successful in 5s
Details
CI/CD Pipeline / docker (push) Successful in 1m28s
Details
CI/CD Pipeline / deploy (push) Successful in 8s
Details
docs: добавить правила монорепозиториев 
- добавлен раздел о применении SLM в монорепозиториях
- обновлена навигация документации и обзор архитектуры
- обновлены сгенерированные артефакты документации
2026-05-11 15:57:29 +03:00

2.2 KiB
Raw Blame History

title
title
Документация

Документация

Раздел помогает быстро найти нужное правило SLM Design. Здесь собраны маршруты чтения, карта разделов и ссылки на материалы для AI-ассистентов.

С чего начать

  • Если вы знакомитесь с подходом впервые — начните с SLM Design.
  • Если проектируете структуру src/ — откройте Слои.
  • Если создаёте новый домен или блок интерфейса — используйте Модули.
  • Если выбираете папку внутри модуля — смотрите Сегменты.
  • Если адаптируете SLM к монорепозиторию — откройте Монорепозитории.

Разделы

Раздел Когда открывать
SLM Design Нужно понять общую идею архитектуры и контекст правил.
Слои Нужно определить, где должен жить код и какие зависимости допустимы.
Модули Нужно оформить границы модуля, публичный API или фабрику.
Сегменты Нужно выбрать внутреннюю папку для компонента, хука, стиля, типа или конфига.
Монорепозитории Нужно понять, что можно выносить в packages/* и какие слои остаются внутри приложения.

Для ассистентов

  • /llms.txt — краткая карта документации.
  • /llms-full.txt — полный контекст архитектуры.
  • /slm-design.zip — архив Markdown-файлов.