Developer documentation index

Clean Framework · DOCUMENTATION

Bounded candidate reference — 2026-10-20: 0.2.0-rc.1 is committed locally through 84f415b3098af5653577b2c65eea31fca21df79c, unpublished and not production-approved; stable PHP >=8.5.11 <8.6.0 is required. This is documentation, not adoption: this knowledge base retains its installed 0.1.0-rc.1 dependency and PHP 8.2.11 local profile. Dated PHP 8.2 evidence is historical; earlier dirty-source reports retain their original test provenance, not retroactive clean-commit proof. Candidate examples are illustrative: API signatures were reviewed, but candidate code was not executed by this editorial update. See current checkpoint, open criteria and adoption boundary.

Start with the candidate checkpoint before following new-framework recipes. Local pilot evidence is not release or production approval.

Current scanner/quarantine hardening: CF-SEC-Q03 guide, report, issue register and original-criteria crosswalk. Local results are not production feed, host or independent review qualification.

Post-Phase-E qualification: Phase B report records bounded native/lifecycle tests and retained failure history. Phase C report records isolated operations and unsigned human/host/owner review packets. Read its final-verification status before interpreting completion. Original acceptance and release gates remain open; these reports do not authorize deployment.

Consolidated Phase E reached its local E-020 reporting boundary: the release-decision dossier reconciles actual source, all100task/150case outcomes and the original15 gates. It is planning/evidence, not release/commit/deployment or bridge retirement. See its E-020 report for ten local VERIFIED tasks, nine blocked requirements and one partial role/ monitoring item. Original acceptance and release qualification remain open.

Supplemental owner-approved native work after D-020: media, quarantine and independent worker monitoring documents the new opt-in classes, actual finite native tests and remaining production/human qualification. Earlier phase receipts remain historical; no module activation, release approval or Phase E is implied.

Optional capability composition: central per-application module activation defines typed independent environments, readiness versus authorization, lazy entry-point admission, migration aliases and safe controlled restart/UNKNOWN rules.

Module corrections: Phase A completion and stop records F-01/F-02, exact evidence and compatible adoption. Its stop preceded the subsequent explicit Phase B approval. Phase C has since been separately authorized and is subject to the current correction checkpoint below.

Phase B reached B-020 completion and STOP: F-03 fixed locally; owner approved JSON preferences to resolve F-04 without executing PHP config. Local adoption/lifecycle and all6 scoped gates pass. Saved locally as05398da;no release is authorized.

Phase C reached C-010,then stopped at C-014:actual ENOSPC exposed an unchanged FileAuditSink integrity defect.13 tasks VERIFIED, 1 FAILED,6 NOT RUN at that historical stop. The subsequently owner-approved OPS-F01 correction is now locally verified with byte-preserving full-disk regression evidence. The owner-requested correction pause was honored before separate resume. Phase C has now reached C-020 completion and STOP: 20 locally VERIFIED tasks,34 scoped case passes and1 conditional branch not triggered. The literal OPS predicate crosswalk keeps original OPS-06/OPS-10 TO VERIFY;no original-gate or release promotion.

Post-C020 O4-06 quota-unavailable follow-up adds a real absent-mount negative profile and shared guarded padding writer. The actual absent-mount gate now passes with physical exhaustion explicitly BLOCKED before any write. Separate real8MiB ENOSPC regression,quality and verify pass;all5 owned containers are absent. Current35 scoped expectations include1 expected-BLOCKED pass. The C02034-pass/1-untriggered snapshot above is historical; original acceptance and external release gates remain unchanged.

This is the current reading map for the neutral framework. A documented API is not automatically verified on every deployment platform. Read the support matrix and deferred work before selecting adapters or promising a feature.

Minor stabilization: first-application recipe, final phase report, generic commerce-planning transition, independent onboarding record, original-open-case dispositions and current phase status. Automated examples are not human onboarding, security signoff or production approval.

Release vocabulary and operator guidance: status glossary, worker/UNKNOWN recovery, media/scanner disablement, upgrade/deprecation and governance/comparator review.

Completed Major work with qualification gates open: phase status, task/evidence ledger, media profile, scanner/accessibility, legacy/host choices, integration limits and scoped SBOM. Local verification is not external qualification, module activation or release approval.

Urgent stabilization: phase report, task/evidence ledger, atomic webhook adoption, reviewer packet, host/recovery gates and owner decisions. Local atomicity is not deployment, independent review or release permission.

Current owner/contact follow-up: reporting and response procedure and current phase status supersede the earlier report's missing-contact result. Historical source/test evidence is preserved; actual independent/host assurance remains open.

Next Generation: local pilot recipes, qualified module boundaries, operations and recovery, maintenance and candidate release, dependency inventory and continuous recovery journal.

Start here

Architecture and ownership: where framework mechanics end and application policy begins.
Directory structure and coding standards: placement, naming, comments, and contribution conventions.
New application checklist and complete application walkthrough: composition from configuration through a route, repository, service, controller, and view.
Behavioral API guide: source contracts, failure semantics, and examples rather than a list of class names.
Troubleshooting: safe local diagnostics and common configuration, routing, security, view, and asset failures.

Runtime topics

Need	Guide
Select DEV, TEST, STAGE, or PROD and inject secrets	Configuration
Bind services, choose lifetimes, and freeze composition	Container
Understand handling, sending, and termination	Kernel lifecycle
Read input, validate limits, and return responses	HTTP
Register routes and enforce cross-cutting policy	Routing and middleware
Render escaped native PHP templates	Views
Generate public URLs and image derivatives	Assets
Bind SQL values and operate immutable migrations	Database and migrations
Compose identities, sessions, and access policy	Authentication and security
Classify, retain, audit, and inspect private data	Privacy and retention
Use cache, mail ports, validation, and private storage	Utility modules
Run jobs, outbox reconciliation, schedules, and coordination	Queue and scheduler
Adapt providers, OAuth, and signed webhooks	Providers and webhooks
Apply AI budgets, schemas, and separately authorized actions	AI and Assisted Actions
Inspect media, append revisions, and observe readiness	Media, revisions, and observability
Compose console commands and prepare Apache	CLI and operations
Understand the deferred browser interaction pattern	AJAX contract

AJAX-only navigation, compiled template caching, and native production media processing are not silently enabled by these guides. Each guide identifies what exists, what the application must supply, and what still needs proof.

Verification and maintenance

Local Git checkpoint and ZIP backup records owner save authority, exact-commit provenance, exclusions and recovery limits.
Next-generation work register, PHP 8.5 migration, and Decision 0003 record the newly approved source target, exact blockers and resumable acceptance state. The older PHP 8.2 evidence below is historical, not qualification for this candidate.
ChatGPT planning briefing, package guide and coding handoff template support owner-approved planning in ChatGPT and evidence-backed implementation in Codex. The export is a sanitized reference, not a runnable release.
Development synchronization checkpoint reconciles current source/evidence with the planning chat before further work.
Knowledge-base editorial handoff and topic update map support a separate KB chat updating developer content without adopting the candidate runtime.
PHP 8.2 and Apache compatibility defines the selected minor line, actual module/FPM evidence and remaining patch/host acceptance. Decision 0002 supersedes the earlier minimum-version target.
Framework gaps and competitive roadmap records the advisory Laravel/Symfony comparison, open gaps, measurable improvement targets and fair-comparison protocol.
Development pipeline and evidence gates defines the proposed work order, local checks, isolated acceptance, documentation publication and separately authorized release process.
Testing, platform matrix, and verification report describe local evidence and separately authorized acceptance work.
Portability and release, release checklist, and deferred components distinguish a local release candidate from deployment readiness.
Change log, implementation ledger, and active-work marker support interrupted work. Historical transcripts are not current copy-and-paste procedures.

Extraction provenance, not onboarding prerequisites

Extraction scope, manifest, source audit, source-tree migration, Phase 0 reconciliation, and Decision 0001 explain why source components were preserved, replaced, or omitted. The optional legacy bridge is not a dependency of a new neutral application.

Keeping examples trustworthy

Read each fragment's setup assumptions; snippets are not full applications. Prefer the linked source file for a complete implementation. Review semantic API comments when changing behavior, update the relevant guide, run composer test and composer verify, and record results without promoting external TO VERIFY items to passes. See API_GUIDE.md for the limits of automated documentation checks.

Editorial provenance

Source: docs/INDEX.md. Source SHA-256: 385aff294fea39b39eec2fd31195b697282cb404d5a8ef619eddfa6669b5ea3e.

Framework candidate reference; editorial checkpoint 2026-10-20. See candidate status and adoption boundary.