Files
slm-design/docs/index.md
S.Gromov 54b4060b6f feat: добавить лендинг, переписать документацию и унифицировать генерацию
- Добавлен лендинг на React + Vite с темой и карточками навигации
- Добавлен модуль темы (src/infra/theme) с поддержкой system/light/dark
- Документация переписана: разделы «Модули», «Сегменты», «Компонент»
- Добавлена страница навигации docs/index.md
- Генерация llms.txt переведена на парсинг сайдбара VitePress
- Описания для llms.txt вынесены в frontmatter (поле description)
- Удалена директория generated/, архив ZIP убран с лендинга
- Удалены английская документация, README_RU, concat-md.js
- Добавлен vite-плагин для UTF-8 заголовков текстовых артефактов
- Caddyfile обновлён: charset=utf-8 для llms.txt и ARCHITECTURE.md
2026-05-01 21:08:38 +03:00

1.8 KiB
Raw Blame History

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

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

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

С чего начать

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

Разделы

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

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

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