docs: add public architecture handbook - #93
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a sanitized, indexed public architecture handbook and refocus the root README on general users. The handbook now explains the package mental model, capabilities, governance and family-independence controls, sealed authorities, installation and operations, repository/release structure, and the evidence states that separate source, tags, releases, installed packages, and active routes.
The documentation is deliberately layered and human-first. It gives users complete lifecycle guidance but does not publish a single turnkey executor specification, raw provider recipes, private producer internals, operator paths, host identities, or secret-bearing discovery commands.
This change also:
CHANGELOG.md.Boundary declaration
Generated and release surfaces
SKILL.mdfiles are in parity.changelog.d/2026-08-06-public-architecture-handbook.mdfragment is present; generatedCHANGELOG.mdis unchanged.origin/main4.9.0.Verification
python3 scripts/build_skills.py --check— 50 generated skills match.python3 scripts/build_marketplace.py --check— both marketplace views match.python3 scripts/build-changelog.py --dry-run— preview succeeds;--checkis release-PR-only under the fragment-only convention and correctly reports the uncompiled fragments.python3 -m unittest discover -s tests -t . -v— 660 tests, OK.python3 -m unittest discover -s scripts -p 'test_*.py' -v— 333 tests, OK.python3 scripts/check_release_consistency.py --against-ref origin/main— RESULT: OK.python3 scripts/secret_scan.py— 369 source text files, clean.python3 scripts/check-public-export-safety.py --active-tree— SAFE in the publication worktree.python3 scripts/check-public-export-safety.py --active-tree --history— the linked clone retains pre-sanitization lineage and correctly fails history mode; no output from that scan is reproduced here. A disposable full clone of the canonical remote at publication HEAD11caf3f29271b34c597665f313d942b3025d2a9e,origin/main465c70ecfe7672be53c9624907a363775c2f9eb9, all fetched remote heads, and tags through v4.6.0 returnedRESULT: SAFE FOR REQUESTED PUBLIC EXPORT CHECKS.git diff --check— clean.11caf3f29271b34c597665f313d942b3025d2a9e.Review and post-condition
Tier 2: user-visible distributed documentation and compatible metadata corrections.
Two exact-head governance calls exposed a verdict-adapter mismatch: both used native repository reads, found zero material issues, and said
PROCEEDin their review prose, while the closed field remainedNEEDS_DISCUSSION. They are recorded as non-converged and do not supply approval.The accepted Tier-2 path is the independent
review.repositorycontract. It inspected the unchanged exact head through a provider-neutral receipt with Google-family lineage distinct from the OpenAI author, read the README, handbook, governance, design registry, changelog, and host manifests natively, and returned zero actionable findings withNO_FINDINGS_VERIFIED. Primary verification of that closed no-findings artifact plus the deterministic gates above yields the final operative verdict: PROCEED.Post-merge: fetch and verify
origin/maincontains the merged handbook and 4.9.1 surfaces; verify the merge workflow conclusion. No release or tag is expected from a documentation PR merge alone. Merge only after required checks are green, review threads are resolved, compliance is merge-eligible, and without--admin.Compliance trace
author: Codex (OpenAI) on behalf of @sumitake
standing_directives: AGENTS.md source and validation boundaries; docs/public-governance.md; signed-commit, exact-head review, clean-history comparison, normal-merge, and no-admin-bypass requirements
tier: 2
cross_check: rounds 1-2 governance adapter recorded NEEDS_DISCUSSION despite zero findings and were excluded; final exact-head review.repository used independent Google-family native reads and a provider-neutral receipt, returned 0 findings and NO_FINDINGS_VERIFIED; primary synthesis PROCEED
post_condition: required CI green; threads resolved; normal squash merge without admin bypass; origin/main and merge automation verified; no release expected without a signed tag
mcp_coverage_gap: NONE
contributor_rights: OWNER-AUTHORED
operator_reserved: no