Larena Documentation

Russian documentation for the Larena developer foundation. The site is built with Docara 3 (simai/docara ^3.0.2, from https://github.com/simai/docara) and is intended to be served locally at https://larena-doc.test. Docara writes its build receipts beside the output, in build_<env>.docara/.

Build

LARENA_DOC_PHP="${LARENA_DOC_PHP:-/Applications/ServBay/package/php/8.4/8.4.20/bin/php}"
LARENA_DOC_COMPOSER="${LARENA_DOC_COMPOSER:-/Applications/ServBay/package/bin/composer}"
"$LARENA_DOC_PHP" "$LARENA_DOC_COMPOSER" install
"$LARENA_DOC_PHP" vendor/bin/docara doctor --json
# The build compiles Composition Recipes with the exact pinned Framework:
# a checkout of simai/ui at the revision named in simai-framework.lock.json
# (runtime.ui.commit) and Node.js 20.
DOCARA_SIMAI_UI_ROOT=/absolute/path/to/ui DOCARA_NODE_BINARY=/absolute/path/to/node \
"$LARENA_DOC_PHP" vendor/bin/docara build production
"$LARENA_DOC_PHP" vendor/bin/docara verify-static build_production

The documentation toolchain requires PHP 8.4.1 or newer. The defaults above select the verified ServBay PHP 8.4.20 runtime; override the variables when an equivalent runtime is installed elsewhere.

The generated directory is build_production; edit Markdown under content/ru instead of generated files.

Documentation synchronization

The repository tracks every public page against exact Larena Specs, Root, Workspace and package revisions. Run the complete local gate before accepting a package change:

"$LARENA_DOC_PHP" "$LARENA_DOC_COMPOSER" docs:status
"$LARENA_DOC_PHP" "$LARENA_DOC_COMPOSER" docs:engine:status
"$LARENA_DOC_PHP" "$LARENA_DOC_COMPOSER" docs:check

The machine-readable map is contracts/larena-documentation-map.json; accepted decisions are appended to contracts/larena-documentation-decisions.json. The generated Docara source contract and documentation.lock.json must remain current. See docs/maintenance.md for the update procedure.

The engine status also prevents a published site from silently remaining on an older stable tag while substantive Docara changes already exist on upstream main.

Local site

ServBay should serve build_production as the document root for larena-doc.test. After every complete build, verify the exact HTTPS target:

curl -fsSI https://larena-doc.test/ru/

Sources

The frozen source inventory, coverage and maintenance procedure live under docs/. Canonical requirements remain in larena-specs; package implementation and exact technical contracts remain in their package repositories.