docs: уточнить правила и заголовки вложенных разделов
- Подзаголовки архитектуры подняты до самодостаточных: Слои SLM, Модули SLM, Сегменты SLM - Подзаголовки REST-клиентов подняты до самодостаточных: Автогенерация REST-клиента, Ручное создание REST-клиента - Для серверных/клиентских компонентов h1 оставлен коротким, контекст полностью переносится в описание - Лендинг docs/docs/index.md актуализирован под новые имена; «Создание проекта» и «Данные» вынесены в отдельные группы - В CONTRIBUTING описана отдельная группа разделов «Настройка» и весь набор типов: basics, creating-project, setup, usage - Зафиксирован принцип: подъём контекста в h1 — только грамматически естественный, иначе контекст переносится в описание - Frontmatter дополнен обязательным полем description - Удалены устаревшие OLD_parts/ и notes
This commit is contained in:
@@ -30,16 +30,16 @@
|
||||
**Описание:** Архитектурный подход проекта: что такое 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
|
||||
**Заголовок:** Стиль кода
|
||||
@@ -154,11 +154,11 @@
|
||||
**Описание:** Какие источники данных используются в проекте и как с ними работать.
|
||||
|
||||
### 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
|
||||
|
||||
Reference in New Issue
Block a user