KoniKode · Software built with intention

KNOWLEDGE BASE

Documentation

DOCUMENTATION
CURRENT APPLICATIONClean Framework
DocumentationClean Framework

Clean Framework · DOCUMENTATION

Publish an approved documentation revision

Publish an approved documentation revision

Steps

Edit human-reviewed local how-tos or the independent framework documentation, review the closed map in config/documents.php, and run the operator import.

Edit framework documentation only when separately authorized in its own repository. A read-only framework reconciliation, such as October 20, edits only KB-owned articles and editorial metadata.

php bin/import-docs
composer test

The importer snapshots only approved guides and example source. It writes immutable hash-named revisions before atomically switching resources/content/current.json. Each request pins one revision; interrupted imports leave the previous pointer selected. Repeated identical imports are idempotent.

Candidate reference is not runtime adoption

Review config/documentation-context.php with the closed document map. It adds visible version/qualification notes, per-article source hashes and checkpoint metadata to the new revision. Framework sources and prior snapshots remain unchanged. Update that context only after reconciling a new source handoff; do not leave an old candidate/version claim attached to newer source bytes.

The application importer runs through this KB's installed vendor/runtime, not the candidate's autoloader. Do not run Composer update, framework tests or exported scripts as part of a content import. No paid index or AI call is needed. Inspect the private import log and preserve previous revisions for in-flight requests and accurate citation checks.

For a bounded synchronization, first verify the framework HEAD and clean source against the approved commit, then reconcile each source hash with the previous manifest. This importer does not check out historical commits or enforce a Git pin: stop if newer or dirty source makes the approved boundary ambiguous. Repeat the source/HEAD check after import. Record the exact commit/tree, original source hash and decorated publication hash in the durable topic map. Do not describe a later commit as a rerun of an older receipt, or treat a preview restart as a new content import. Dated narratives remain historical; current notes must say what supersedes them without modifying old revisions.

Verify

Check the published count, document hashes, private permissions, source links, and tests. Never publish an AI draft automatically. Retain old revisions long enough for in-flight requests; pruning is an offline operator task described in the runbook.

Editorial provenance

Source: resources/guides/import-docs.md. Source SHA-256: d98ae6b53a90409f9e27dbcf3478ac9a373b49d98865482207cc0519bcc89382.

Knowledge-base application source; editorial checkpoint 2026-10-20. See candidate status and adoption boundary.

EXPLORE FURTHER

Drag a divider or use Left and Right Arrow keys to resize. Hold Shift for larger steps. Enter hides or restores the sidebar; Home and End select its minimum or maximum width. Double-click resets the width.

Install KoniKode