---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://ydb.tech/docs/en/contributor/documentation.md?version=v26.1
  - https://ydb.tech/docs/ru/contributor/documentation.md?version=v26.1
  - href: ru/contributor/documentation/index.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
sourcePath: ru/core/contributor/documentation/index.md
---
> **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/ru/llms.txt

# Участие в разработке документации YDB

YDB следует подходу «Документация как код», что означает, что документация YDB разрабатывается с использованием аналогичных методов и инструментов, как и основной исходный код проекта на C++.

Исходный код документации состоит из файлов Markdown и конфигурационных файлов YAML, расположенных в [папке ydb/docs основного репозитория YDB на GitHub](https://github.com/ydb-platform/ydb/tree/main/ydb/docs). Компилятором этого исходного кода является инструмент с открытым исходным кодом под названием [Diplodoc](https://diplodoc.com/ru). Подробности о его диалекте Markdown, параметрах конфигурации, расширениях и многом другом можно найти в [его документации](https://diplodoc.com/docs/ru/).

Процесс предложения изменений в исходном коде документации в основном аналогичен изменению любого другого исходного кода YDB, поэтому большая часть [Процесс разработки: работа над изменениями кода YDB](https://ydb.tech/docs/ru/contributor/suggest-change.md?version=v26.1) применима. Основные дополнительные особенности:

- Для pull-запросов к документации выполняются [дополнительные прекоммитные проверки](https://github.com/ydb-platform/ydb/actions/workflows/docs_build.yaml). Одна из этих проверок оставляет комментарий со ссылкой на онлайн-предпросмотр изменений или список ошибок.
- Процесс ревью кода включает дополнительные шаги. См. [Процесс ревью документации YDB](https://ydb.tech/docs/ru/contributor/documentation/review.md?version=v26.1) и [Руководство по стилю документации YDB](https://ydb.tech/docs/ru/contributor/documentation/style-guide.md?version=v26.1).
- Для небольших изменений, таких как исправление опечатки, можно использовать функцию «Edit this file» в веб-интерфейсе GitHub. Каждая страница документации имеет ссылку «Edit on GitHub» (представлена значком карандаша в правом верхнем углу), которая ведёт к исходному коду страницы в веб-интерфейсе GitHub.

После мёрджа pull-запроса с документацией в ветку `main` [CI/CD-пайплайн](https://github.com/ydb-platform/ydb/actions/workflows/docs_release.yaml) автоматически публикует её на сайте YDB. Документация также автоматически публикуется для стабильных версий сервера YDB из веток `git` с именами `stable-*`, где разрабатываются эти версии. Если код C++ и документация для функции были закоммичены отдельно, и между этими коммитами была создана новая стабильная ветка, может потребоваться бекпортирование некоторых изменений в стабильную ветку. То же самое относится к исправлению опечаток и другим «багфиксам» в содержании документации. Подробнее о процессе релиза YDB см. [Manage YDB releases](https://ydb.tech/docs/ru/contributor/manage-releases.md?version=v26.1).

## См. также

- [Структура документации YDB](https://ydb.tech/docs/ru/contributor/documentation/structure.md?version=v26.1)
- [Жанры документации YDB](https://ydb.tech/docs/ru/contributor/documentation/genres.md?version=v26.1)
- [Документация GitHub](https://docs.github.com/en)
- [Документация Git](https://git-scm.com/doc)
- [Добавление медиа в публичные материалы](https://ydb.tech/docs/ru/contributor/documentation/guide-to-public-material.md?version=v26.1)
- [Документирование новых команд CLI](https://ydb.tech/docs/ru/contributor/documentation/cli-command-documentation.md?version=v26.1)