S.Gromov
1195c7b75d
- Подзаголовки архитектуры подняты до самодостаточных: Слои SLM, Модули SLM, Сегменты SLM - Подзаголовки REST-клиентов подняты до самодостаточных: Автогенерация REST-клиента, Ручное создание REST-клиента - Для серверных/клиентских компонентов h1 оставлен коротким, контекст полностью переносится в описание - Лендинг docs/docs/index.md актуализирован под новые имена; «Создание проекта» и «Данные» вынесены в отдельные группы - В CONTRIBUTING описана отдельная группа разделов «Настройка» и весь набор типов: basics, creating-project, setup, usage - Зафиксирован принцип: подъём контекста в h1 — только грамматически естественный, иначе контекст переносится в описание - Frontmatter дополнен обязательным полем description - Удалены устаревшие OLD_parts/ и notes
175 lines
7.8 KiB
Markdown
175 lines
7.8 KiB
Markdown
# Обзор страниц документации
|
||
|
||
Список всех `.md`-страниц в `docs/docs/` в порядке сайдбара (`.vitepress/config.ts`).
|
||
Поля: путь к файлу, заголовок (`h1`), описание (абзац под заголовком).
|
||
|
||
## Главная
|
||
|
||
### docs/docs/index.md
|
||
**Заголовок:** NextJS Style Guide
|
||
**Описание:** Стандарты разработки фронтенд-приложений на Next.js и TypeScript.
|
||
|
||
## Подсказки
|
||
|
||
### docs/docs/workflow.md
|
||
**Заголовок:** Подсказки
|
||
**Описание:** Короткие ответы на типовые вопросы и решения для спорных ситуаций.
|
||
|
||
## Базовые правила
|
||
|
||
### docs/docs/basics/tech-stack.md
|
||
**Заголовок:** Технологии и библиотеки
|
||
**Описание:** Какие библиотеки и инструменты используются в проекте.
|
||
|
||
### docs/docs/basics/naming.md
|
||
**Заголовок:** Именование
|
||
**Описание:** Как называть переменные, файлы и прочие сущности в коде.
|
||
|
||
### docs/docs/basics/architecture/index.md
|
||
**Заголовок:** SLM Design
|
||
**Описание:** Архитектурный подход проекта: что такое SLM и как он устроен.
|
||
|
||
### docs/docs/basics/architecture/reference/layers.md
|
||
**Заголовок:** Слои SLM
|
||
**Описание:** Из каких слоёв состоит SLM-архитектура и как они связаны.
|
||
|
||
### docs/docs/basics/architecture/reference/modules.md
|
||
**Заголовок:** Модули SLM
|
||
**Описание:** Что такое модуль в SLM-архитектуре и как он устроен.
|
||
|
||
### docs/docs/basics/architecture/reference/segments.md
|
||
**Заголовок:** Сегменты SLM
|
||
**Описание:** Что такое сегмент модуля в SLM-архитектуре и какие они бывают.
|
||
|
||
### docs/docs/basics/code-style.md
|
||
**Заголовок:** Стиль кода
|
||
**Описание:** Как оформляется код в проекте.
|
||
|
||
### docs/docs/basics/documentation.md
|
||
**Заголовок:** Документирование
|
||
**Описание:** Что и как документировать в коде.
|
||
|
||
### docs/docs/basics/typing.md
|
||
**Заголовок:** Типизация
|
||
**Описание:** Как типизируется код в проекте.
|
||
|
||
## Создание проекта
|
||
|
||
### docs/docs/creating-project/from-template.md
|
||
**Заголовок:** Создание проекта из шаблона
|
||
**Описание:** Создание нового проекта на основе готового шаблона.
|
||
|
||
### docs/docs/creating-project/manual.md
|
||
**Заголовок:** Создание проекта вручную
|
||
**Описание:** Поэтапное создание нового проекта без использования шаблона.
|
||
|
||
### docs/docs/creating-project/nextjs.md
|
||
**Заголовок:** Чистая установка Next.js
|
||
**Описание:** Установка Next.js без лишнего шаблона — голый каркас под дальнейшую сборку.
|
||
|
||
## Настройка
|
||
|
||
### docs/docs/setup/aliases.md
|
||
**Заголовок:** Алиасы импортов
|
||
**Описание:** Какие алиасы импортов есть в проекте и как ими пользоваться.
|
||
|
||
### docs/docs/setup/biome.md
|
||
**Заголовок:** Biome
|
||
**Описание:** Установка и настройка линтера-форматтера в новом проекте.
|
||
|
||
### docs/docs/setup/postcss.md
|
||
**Заголовок:** PostCSS
|
||
**Описание:** Установка и настройка CSS-процессора в новом проекте.
|
||
|
||
### docs/docs/setup/styles.md
|
||
**Заголовок:** Стили
|
||
**Описание:** Подготовка стилевой основы проекта: токены, медиа-запросы, глобальные стили.
|
||
|
||
### docs/docs/setup/svg-sprites.md
|
||
**Заголовок:** SVG-спрайты
|
||
**Описание:** Подключение SVG-спрайтов в новом проекте.
|
||
|
||
### docs/docs/setup/templates.md
|
||
**Заголовок:** Шаблоны генерации
|
||
**Описание:** Подключение шаблонов кодогенерации в новом проекте.
|
||
|
||
### docs/docs/setup/vscode.md
|
||
**Заголовок:** VS Code
|
||
**Описание:** Единые настройки редактора и расширений для команды.
|
||
|
||
## Использование
|
||
|
||
### docs/docs/usage/project-structure.md
|
||
**Заголовок:** Структура проекта
|
||
**Описание:** Из чего состоит проект и где что лежит.
|
||
|
||
### docs/docs/usage/components.md
|
||
**Заголовок:** Компоненты
|
||
**Описание:** Как устроен и пишется React-компонент в проекте.
|
||
|
||
### docs/docs/usage/page-level.md
|
||
**Заголовок:** Файлы роутинга
|
||
**Описание:** Что должно лежать в файлах роутинга, а что — в экранах.
|
||
|
||
### docs/docs/usage/templates-generation.md
|
||
**Заголовок:** Шаблоны и генерация кода
|
||
**Описание:** Как устроены шаблоны кодогенерации и как ими пользоваться.
|
||
|
||
### docs/docs/usage/styles.md
|
||
**Заголовок:** Стили
|
||
**Описание:** Как пишутся стили в проекте.
|
||
|
||
### docs/docs/usage/images-sprites.md
|
||
**Заголовок:** —
|
||
**Описание:** _(файл пустой)_
|
||
|
||
### docs/docs/usage/svg-sprites.md
|
||
**Заголовок:** SVG-спрайты
|
||
**Описание:** Как добавлять и использовать SVG-иконки в коде.
|
||
|
||
### docs/docs/usage/video.md
|
||
**Заголовок:** —
|
||
**Описание:** _(файл пустой)_
|
||
|
||
### docs/docs/usage/stores.md
|
||
**Заголовок:** —
|
||
**Описание:** _(файл пустой)_
|
||
|
||
### docs/docs/usage/hooks.md
|
||
**Заголовок:** —
|
||
**Описание:** _(файл пустой)_
|
||
|
||
### docs/docs/usage/fonts.md
|
||
**Заголовок:** —
|
||
**Описание:** _(файл пустой)_
|
||
|
||
### docs/docs/usage/localization.md
|
||
**Заголовок:** —
|
||
**Описание:** _(файл пустой)_
|
||
|
||
## Данные
|
||
|
||
### docs/docs/usage/data/index.md
|
||
**Заголовок:** Источники данных
|
||
**Описание:** Какие источники данных используются в проекте и как с ними работать.
|
||
|
||
### docs/docs/usage/data/rest/clients/auto.md
|
||
**Заголовок:** Автогенерация REST-клиента
|
||
**Описание:** Генерация REST-клиента из OpenAPI-спецификации.
|
||
|
||
### docs/docs/usage/data/rest/clients/manual.md
|
||
**Заголовок:** Ручное создание REST-клиента
|
||
**Описание:** Создание REST-клиента вручную, когда нет OpenAPI-спецификации.
|
||
|
||
### docs/docs/usage/data/rest/fetching/server.md
|
||
**Заголовок:** Серверные компоненты
|
||
**Описание:** Получение REST-данных в серверных компонентах.
|
||
|
||
### docs/docs/usage/data/rest/fetching/client.md
|
||
**Заголовок:** Клиентские компоненты
|
||
**Описание:** Получение REST-данных в клиентских компонентах.
|
||
|
||
### docs/docs/usage/data/realtime.md
|
||
**Заголовок:** Realtime
|
||
**Описание:** Работа с push-данными от сервера: подписки и события.
|