Как править вики#

Вики - это репозиторий librecapsula/librecapsula.github.io: Markdown в docs/, сборка MkDocs Material, публикация автоматическая по мержу в main. Любые правки - через pull request; на каждой странице есть ссылка «редактировать» (иконка карандаша справа вверху).

Локальная сборка#

python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

mkdocs serve            # превью: http://127.0.0.1:8000
mkdocs build --strict   # проверка: должна проходить без warnings

--strict обязателен: CI валит сборку при любых warnings (битые ссылки, страницы вне nav и т.п.).

Правила контента#

Язык - русский. Термины, идентификаторы команд и логи - как в оригинале (download-режим, userdata, vbmeta).
Только проверённое. Факт без источника - помечайте TODO: и опишите, что нужно подтвердить. Не публикуйте домыслы о железе/прошивках.
Не публикуемое: дампы прошивок, ключи, серийники, содержимое заводского 10_security. Инструменты сами скачивают OTA с VK CDN - в вики только знания, не образы.
Формат:
- одна страница = одна тема; заголовки ## внутри;
- предупреждения - !!! warning, заметки - !!! note, раскрывающиеся блоки - ??? note "Заголовок";
- различия платформ - табы === "Capsule-14" (свяжутся в одну группу);
- клавиши - ++ctrl+d++;
- команды - в блоках ```sh с указанием, где они выполняются.
Новая страница: создайте docs/<раздел>/<страница>.md, добавьте её в nav в mkdocs.yml (иначе strict-warning), проверьте сборку.
Ссылки внутри вики - относительные на .md (../hardware/uart.md); slugify вырезает кириллицу, поэтому заголовкам, на которые ссылаются, вешайте явные ASCII-якоря через attr_list: ## Заголовок {#my-id} и ссылайтесь как page.md#my-id.

Стиль страниц устройств#

Скопируйте существующую карточку (Капсула - самая заполненная): таблица характеристик сразу под заголовком страницы (на всю ширину), всё остальное - под ней: Модели и ревизии → Железо → Вход в режим загрузки → Прошивки → Поддержка. Незаполненное - честный TODO-список.