docs/canons/style-guide/MAP.md

Карта документации

Список всех разделов архива с относительными ссылками. Точка входа — DEVELOP.md рядом с этим файлом.

Подсказки

• Подсказки — Короткие ответы на типовые вопросы и решения для спорных ситуаций.

Базовые правила

• Технологии и библиотеки — Какие библиотеки и инструменты используются в проекте.
• Именование — Как называть переменные, файлы и прочие сущности в коде.
• Архитектура: Обзор — Архитектурный подход проекта: что такое SLM и как он устроен.
• Архитектура: Слои — Из каких слоёв состоит SLM-архитектура и как они связаны.
• Архитектура: Модули — Что такое модуль в SLM-архитектуре и как он устроен.
• Архитектура: Сегменты — Что такое сегмент модуля в SLM-архитектуре и какие они бывают.
• Стиль кода — Как оформляется код в проекте.
• Документирование — Что и как документировать в коде.
• Типизация — Как типизируется код в проекте.

Прикладные разделы

• Создание проекта: Из шаблона — Создание нового проекта на основе готового шаблона.
• Создание проекта: По гайду вручную — Поэтапное создание нового проекта без использования шаблона.
• Создание проекта: Чистый Next.js — Установка Next.js без лишнего шаблона — голый каркас под дальнейшую сборку.
• Структура проекта — Из чего состоит проект и где что лежит.
• Страницы — Как работать со страницами и другими файлами роутинга Next.js App Router.
• Компонент — Как создавать React-компоненты внутри SLM-модулей.
• Модуль — Как создавать и организовывать SLM-модули в проекте.
• REST-клиент — Настройка REST-клиента сервиса для работы с внешним API.
• REST-клиент: Настройка REST-клиента — Из чего состоит REST-клиент и что подготовить перед использованием API.
• REST-клиент: Автогенерация REST-клиента — Генерация REST-клиента из OpenAPI-спецификации.
• REST-клиент: Ручное создание REST-клиента — Создание REST-клиента вручную, когда OpenAPI нет или он неполный.
• REST-клиент: GET-хуки REST-клиента — Прозрачные SWR-обёртки над GET-методами REST-клиента.
• REST-клиент: Использование REST-клиента — Как вызывать готовый REST-клиент в серверном коде и submit-функциях.
• Получение данных — Как получать данные с учётом рендера страницы.
• Получение данных: Серверный await — Получение REST-данных на сервере до первого HTML.
• Получение данных: Параллельные серверные запросы — Как запускать независимые REST-запросы на сервере без waterfall.
• Получение данных: Передача промиса ниже — Как запускать серверный REST-запрос выше и ожидать его во вложенном server-компоненте.
• Получение данных: Начальные данные для клиентских хуков — Как дать клиентским GET-хукам начальные REST-данные.
• Получение данных: Клиентский GET-хук — Получение REST-данных в Client Components через готовые GET-хуки REST-клиента.
• Получение данных: Business-композиция — Когда REST-данные нужно объединить или интерпретировать в бизнес-модуле.
• Стили: Настройка — Подготовка стилевой основы проекта: токены, медиа-запросы, глобальные стили.
• Стили: Использование — Как пишутся стили в проекте.
• SVG-спрайты — Что такое SVG-спрайты и какие проблемы они решают.
• SVG-спрайты: Настройка — Подключение SVG-спрайтов в новом проекте.
• SVG-спрайты: Использование — Как добавлять и использовать SVG-иконки в коде.
• Изображения — Как подключать изображения через Next.js Image в проекте.
• Шрифты — Как подключать шрифты через Next.js Font в проекте.
• Алиасы импортов — Какие алиасы импортов есть в проекте и как ими пользоваться.
• Шаблоны генерации — Что такое шаблоны кодогенерации и какие проблемы они решают.
• Шаблоны генерации: Настройка — Первичная установка шаблонов кодогенерации в проект.
• Шаблоны генерации: Создание шаблонов — Структура шаблонов, синтаксис переменных и примеры.
• Шаблоны генерации: Использование — Генерация файлов из шаблонов через VS Code плагин и CLI.
• Biome — Установка и настройка линтера-форматтера в новом проекте.
• PostCSS — Установка и настройка CSS-процессора в новом проекте.
• VS Code — Единые настройки редактора и расширений для команды.
• Локализация — Как организовать локализацию как infra-модуль.