docs/nextjs-style-guide

Fork 0

Files

S.Gromov 028a69f3ac

CI/CD Pipeline / docker (push) Successful in 51s

Details

CI/CD Pipeline / deploy (push) Successful in 9s

Details

docs: переработать заголовки и описания разделов

- Зафиксированы новые правила в CONTRIBUTING.md: заголовок и описание
  как навигационный маркер, запреты, тесты и подходящие формы
- Описания во всех 26 разделах переписаны как короткий ответ на
  вопрос «когда сюда нужно?»
- Заголовки приведены к самодостаточному виду: SLM Design, SVG-спрайты,
  VS Code, Чистая установка Next.js, Источники данных, Создание
  проекта вручную, Стили, Алиасы импортов
- Описания добавлены в frontmatter (description) для согласованности
  с llms.txt и SEO
- Удалены навигационные ссылки сразу после описания
- Добавлен docs-overview.md — сводный обзор всех страниц
- Обновлён сайдбар: ссылка «Алиасы» → «Алиасы импортов»

2026-04-28 15:35:10 +03:00

7.7 KiB

Raw Blame History

Обзор страниц документации

Список всех .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

Заголовок: Слои Описание: Из каких слоёв состоит архитектура и как они связаны.

docs/docs/basics/architecture/reference/modules.md

Заголовок: Модули Описание: Что такое модуль в архитектуре и как он устроен.

docs/docs/basics/architecture/reference/segments.md

Заголовок: Сегменты Описание: Что такое сегмент модуля и какие они бывают.

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

Заголовок: Шаблоны и генерация кода Описание: Как устроены шаблоны кодогенерации и как ими пользоваться.