Tyapkin
Runbooks

Проверенный экспорт в TechDocs

Где лежит контракт, что генерирует Tyapkin и что добавляет Allium.

Проверенный экспорт в TechDocs

Tyapkin хранит проверяемые определения в опубликованном Feature package. FeatureConsumerV1::documentation_snapshot повторно проверяет bytes, owner authority, extensions и exact зависимости. Snapshot показывает Feature, Scenario, Machine, Principal, Capability, State, Input, Guard, Transition, Output и TypeRef/Flow refs. published-checked не означает активацию или исполнение: release binding указан как not-asserted, исполнение и доставка — not-observed.

Опциональный techdocs-projection вызывает этот consumer и создаёт новый TechDocs source bundle: snapshot.json, manifest.json, mkdocs.yml, docs/index.md и отдельные страницы Feature/Machine. Это реальные исходники для MkDocs/TechDocs; Fumadocs остаётся базой знаний о языке и протоколе.

catalog-info.yaml появляется только при переданных host metadata: Catalog name, owner, lifecycle и опциональном system. Tyapkin не регистрирует Entity в Backstage. Без metadata страницы всё равно генерируются. Kernel, компилятор одной Machine и decide/verify_trace не зависят от TechDocs.

Принимающий Allium проверяет закреплённый package ref, добавляет к базовым страницам свои LayerPackage, ApplicationRelease и эксплуатационные сведения, а затем владеет каталогом и публикацией. Текущий экспорт сам по себе ещё не подключён к сайту Allium.

Локальная проверка

python3.12 -m venv target/techdocs-venv
target/techdocs-venv/bin/python -m pip install -r tools/techdocs/requirements.lock
python3 scripts/build-consumer-bundle.py --allow-dirty --techdocs-output-dir target/techdocs-preview
target/techdocs-venv/bin/python -m mkdocs build --strict -f target/techdocs-preview/mkdocs.yml --site-dir ../techdocs-preview-html

Полный контракт, структура файлов и ограничения доверия описаны в docs/runbooks/tyapkin-techdocs-export.md.

On this page