docs/nextjs-style-guide

Fork 0

Files

S.Gromov b104ca6581

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

Details

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

Details

docs: рефакторинг документации — workflow, прикладные разделы, генерация RULES.md

- Переработан раздел Workflow: заголовки, описания, порядок разделов
- Добавлены новые разделы: Генерация кода (workflow), Настройка VS Code (applied)
- Убран суффикс .ui.tsx из документации и примеров
- Переработан раздел Структура проекта — только Next.js, без React SPA
- Приоритет стилизации перенесён из applied/styles в workflow/styling
- Убрано дублирование инструментов генерации — единая точка в applied/templates-generation
- Переписан concat-md.js: без внешних зависимостей, мета-якоря для навигации в RULES.md
- Удалена зависимость concat-md
- Обновлена главная страница: названия разделов, URL на RULES.md
- Добавлен AGENTS.md с правилами для агентов

2026-03-29 11:43:23 +03:00

2.3 KiB

Raw Permalink Blame History

NextJS Style Guide

Rules and standards for NextJS and TypeScript development: architecture, typing, styles, components, API, and infrastructure.

Documentation Structure

Processes

What to do in a specific situation — step-by-step instructions.

Section	Answers the question
Getting Started	What tools to install before starting development?
Creating an App	How to create a new project, where to get a template?
Creating Pages	How to add a page: routing and screen?
Creating Components	How to generate components using templates?
Styling	What to use: Mantine, tokens, or PostCSS?
Data Fetching	How to fetch data: SWR, codegen, sockets?
State Management	When and how to create a store (Zustand)?
Localization	How to add translations and work with i18next?

Basic Rules

What the code should look like — standards not tied to a specific technology.

Section	Answers the question
Tech Stack	What stack do we use?
Architecture	How are FSD layers, dependencies, and public API structured?
Code Style	How to format code: indentation, quotes, imports, early return?
Naming	How to name files, variables, components, hooks?
Documentation	How to write JSDoc: what to document and what not?
Typing	How to type: type vs interface, any/unknown, FC?

Applied Sections

How a specific area works — rules, structure, and code examples for specific technologies and tools.

Section	Answers the question
Project Structure	How are folders and files organized by FSD?
Components	How is a component structured: files, props, clsx, FC?
Page-level Components	How to define layout, page, loading, error, not-found?
Templates & Code Generation	How do templates work: syntax, variables, modifiers?
Styles	How to write CSS: PostCSS Modules, nesting, media, tokens?
Images	(not filled)
SVG Sprites	(not filled)
Video	(not filled)
API	(not filled)
Stores	(not filled)
Hooks	(not filled)
Fonts	(not filled)
Localization	(not filled)

For Assistants

Full documentation in a single MD file: https://gromlab.ru/docs/frontend-style-guide/raw/branch/main/generated/en/RULES.md

2.3 KiB Raw Permalink Blame History