docs: обновить структуру прикладных разделов
- перенесён раздел создания проекта в прикладные разделы - переработаны разделы REST-клиента и получения данных - удалена устаревшая категория работы с данными - обновлён стандартный конфиг Biome - добавлены правила для обязательного API baseUrl без fallback - обновлены сайдбар, карта документации, README и ссылки
This commit is contained in:
28
README.md
28
README.md
@@ -37,22 +37,15 @@
|
||||
| Документирование | Как писать JSDoc: что документировать, а что нет? |
|
||||
| Типизация | Как типизировать: type vs interface, any/unknown? |
|
||||
|
||||
### Создание проекта
|
||||
|
||||
**Как начать новый проект** — варианты установки и эталонный набор инструментов.
|
||||
|
||||
| Раздел | Отвечает на вопрос |
|
||||
|--------|-------------------|
|
||||
| Создание проекта из шаблона | Как начать проект из готового шаблона? |
|
||||
| Создание проекта вручную | Как поднять проект с нуля без шаблона? |
|
||||
| Чистая установка Next.js | Как поставить голый Next.js под дальнейшую сборку? |
|
||||
|
||||
### Настройка
|
||||
|
||||
**Как сконфигурировать проект** — пошаговая настройка инструментов и инфраструктуры.
|
||||
|
||||
| Раздел | Отвечает на вопрос |
|
||||
|--------|-------------------|
|
||||
| Создание проекта из шаблона | Как начать проект из готового шаблона? |
|
||||
| Создание проекта вручную | Как поднять проект с нуля без шаблона? |
|
||||
| Чистая установка Next.js | Как поставить голый Next.js под дальнейшую сборку? |
|
||||
| Алиасы импортов | Как настроить алиасы импортов? |
|
||||
| Biome | Как настроить линтер и форматтер? |
|
||||
| PostCSS | Какие плагины PostCSS нужны и как их настроить? |
|
||||
@@ -70,6 +63,8 @@
|
||||
| Структура проекта | Как организованы папки и файлы по SLM? |
|
||||
| Компоненты | Как устроен компонент: файлы, пропсы, clsx? |
|
||||
| Файлы роутинга | Как описывать layout, page, loading, error, not-found? |
|
||||
| REST-клиент | Как настроить клиент внешнего REST API? |
|
||||
| Получение данных | Как выбрать способ получения данных под рендер страницы? |
|
||||
| Шаблоны и генерация кода | Как работают шаблоны, синтаксис и инструменты генерации? |
|
||||
| Стили | Как писать CSS: вложенность, медиа, токены? |
|
||||
| SVG-спрайты | Как использовать SVG-спрайты в коде? |
|
||||
@@ -79,16 +74,3 @@
|
||||
| Хуки | _(не заполнен)_ |
|
||||
| Шрифты | _(не заполнен)_ |
|
||||
| Локализация | _(не заполнен)_ |
|
||||
|
||||
### Данные
|
||||
|
||||
**Как работать с источниками данных** — REST, realtime и потребление в компонентах.
|
||||
|
||||
| Раздел | Отвечает на вопрос |
|
||||
|--------|-------------------|
|
||||
| Источники данных | Как устроена работа с данными в проекте? |
|
||||
| REST: Автоматическая генерация | Как сгенерировать REST-клиент автоматически из OpenAPI? |
|
||||
| REST: Ручное создание | Как написать REST-клиент вручную? |
|
||||
| REST: Серверные компоненты | Как получать данные в серверных компонентах? |
|
||||
| REST: Клиентские компоненты | Как получать данные в клиентских компонентах? |
|
||||
| Realtime | Как работать с realtime-каналами и сокетами? |
|
||||
|
||||
Reference in New Issue
Block a user