Как устроена документация
Русская редакция — основная. Английская редакция сопровождает те же материалы для GitHub. На сайте публикуется русская версия из тех же Markdown, таблиц, схем и примеров. Редактировать отдельно сгенерированный HTML не требуется.
registry.json перечисляет документы, компоненты и версии контрактов. Для каждой страницы записаны SHA-256 русского и английского Markdown, версия документа и хеш русского оригинала, которому соответствует перевод. Изменение оригинала требует проверки перевода. Проверка хеша обнаруживает несовпадение редакций, но не оценивает качество перевода.
Страница «О проекте» задаёт порядок разделов в своём Markdown. Ссылки на HTML-документацию, PDF/ZIP и лабораторию находятся там же. Издатель проверяет доступность ссылок внутри отмеченного раздела документации; готовность HTML не зависит от готовности PDF/ZIP. Отдельные описания в конец страницы не дописываются.
Обновление
При изменении публичного поведения одновременно обновляются соответствующая спецификация, примеры, русская статья и перевод. Контракт получает новую версию при несовместимом изменении. Новая редакция рисунков не становится автоматически новой версией схемы JSON. Для лаборатории сохраняется ссылка на её самостоятельную документацию; общая коллекция не заводит вторую редакцию исследования.
В пакет входят источники Markdown, схемы JSON и примеры, изображения чайной и список исходных проектов. Проверка пакета проверяет реестр, контрольные суммы, локальные ссылки и согласованность переводов. Она не обращается к закрытым настройкам и не требует доступа к аккаунтам.
При проблеме с очередным обновлением документации сайт сохраняет предыдущую опубликованную редакцию. Каталог игр, музыка и обои продолжают собираться. Пакет документации не содержит конфигурацию сервера, ключи и административные журналы.
Единый порядок чтения
Оглавление разделено на семь частей: проект, общее устройство, подпроекты, художественные примеры, спецификации, практические материалы и сопровождение. Группы и порядок страниц задаются reading_groups в registry.json. Из них формируются навигация сайта и последовательность PDF. README даёт вход в книгу; в конце глав есть переходы к соседним материалам. При добавлении главы укажите её в одной группе, обновите обе редакции и оглавление README, затем запустите проверку.
Порядок чтения: Оглавление · Назад: Условия использования