# Настройка GitBook

Эта документация написана как GitBook-книга и синхронизируется из GitHub-репозитория.

## Структура в репозитории

```
.gitbook.yaml          # конфиг GitBook (в корне репозитория)
book/
├── README.md           # вводная страница
├── SUMMARY.md          # оглавление (дерево страниц)
├── getting-started/ ...
├── guide/ ...
└── ...
```

`.gitbook.yaml`:

```yaml
root: ./book/

structure:
  readme: README.md
  summary: SUMMARY.md
```

* `root` — каталог с контентом книги (отделён от внутренней `docs/` с ADR/планами, чтобы не смешивать пользовательскую и проектную документацию).
* `structure.readme` — стартовая страница.
* `structure.summary` — файл оглавления.

## Файл `SUMMARY.md`

Оглавление и дерево страниц — вложенный markdown-список ссылок:

```markdown
# Содержание

- [Введение](README.md)

## Начало работы

- [Установка](getting-started/installation.md)
- [Быстрый старт](getting-started/quickstart.md)
```

Заголовки `##` становятся группами в боковой панели. Порядок ссылок — порядок страниц. Каждая страница книги должна быть в `SUMMARY.md`.

## Подключение к GitBook.com (Git Sync)

1. Создайте организацию/пространство на [gitbook.com](https://gitbook.com).
2. В пространстве: **Sync → GitHub**, авторизуйте GitBook App для репозитория `cataIystdev/catalib`.
3. Выберите репозиторий и ветку (`main`), направление синхронизации (обычно двунаправленное GitHub ↔ GitBook).
4. GitBook прочитает `.gitbook.yaml`, возьмёт контент из `book/` и построит сайт по `SUMMARY.md`.
5. Каждый push в `main` обновляет опубликованную книгу; правки в редакторе GitBook возвращаются коммитами в репозиторий.

Никаких дополнительных файлов, кроме `.gitbook.yaml` и `book/`, не нужно.

## Локальный предпросмотр (Honkit)

`gitbook-cli` не поддерживается. Для локальной сборки удобно **Honkit** (поддерживаемый форк GitBook), он понимает тот же `SUMMARY.md`:

```bash
npx honkit serve book      # локальный сервер с автоперезагрузкой
npx honkit build book _site  # статическая сборка в _site/
```

Honkit — только для предпросмотра/статического экспорта; основная публикация — через GitBook.com Git Sync.

## Правила для страниц

* Каждая страница — отдельный `.md` внутри `book/`, путь относительный.
* Ссылки между страницами — относительные пути (`../guide/hooks.md`).
* Новую страницу обязательно добавлять в `SUMMARY.md`, иначе GitBook её не покажет.
* Front-matter `--- description: ... ---` в начале файла — опционален (используется на стартовой странице).

## Поддержание актуальности

Документация — часть единицы работы. При изменении публичного поведения (CLI, API `catalib.support`, формат манифеста) обновляйте соответствующие страницы `book/` в том же коммите и добавляйте запись в `CHANGELOG.md`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://raito-kyokai.gitbook.io/catalib/kontribyutoram/gitbook.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.