Repository navigation
[Docs][Trust] Disclose route-written Git state, make the installed-Hook comparison optional, and state Codex trust and Windows status - #232
Merged
Conversation
…mparison optional Remote baseline: origin/main @ 3097889 Scope: Four user-facing documentation gaps from Issue #221. The trust model gains a Repository State Written By Routes section that names every location the routes write inside a target repository's Git metadata: the traceable-git-submit baseline cache and active checkpoint record under the Git directory, its backup refs under refs/axiom/backups/traceable-git-submit/<unique-id>, and the agents-architect session capsules under axiom/agents-architect/, with the commands to list and remove them, the legacy working-tree locations, and the user-local ignore entries agents-architect may add. The installed-Hook comparison becomes an optional supply-chain check for reviewers, described once in the trust model's Hook Trust Boundary and referenced from the README, the Getting Started guide (whose Inspect The Hook section becomes Trust The Hook), Managing an Installation, Compatibility, and the Hook Reference, which stays the canonical rendering of the checked-in commands. The README install section now states the Codex /hooks trust step and the Windows status, the Getting Started guide drops the test-repository precondition, Managing an Installation says that disabling or removing Axiom leaves route-written Git state in place, and Compatibility states that neither host has a Windows observation and how CI exercises the Hook commands on Windows. Repository policy revision 119 records the change for Issue #221 in the ledger with an unchanged plugin version and runtime digest. Validation: python3 -B scripts/check-publication.py: passed on the exact tree (153 required files, 169 Markdown files, 30 immutable action pins) python3 -B -m unittest discover -s tests -p 'test_*.py': 315 tests OK in a disposable clone of the tree git diff --check: clean; ASCII scan of the changed Markdown and JSON files: passed
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.
Scope
Refs #221. Four user-facing documentation gaps:
docs/trust-model.mdgains Repository State Written By Routes, naming every location the routes write inside a target repository's Git metadata:axiom/traceable-git-submit-baseline.jsonandaxiom/traceable-git-submit-active-checkpoints.jsonunder the Git directory, backup refs underrefs/axiom/backups/traceable-git-submit/<unique-id>, andagents-architectsession capsules underaxiom/agents-architect/, with when they are written, the commands to list and remove them, the legacy working-tree locations, and the user-local ignore entriesagents-architectmay add. The Boundary Summary gains a matching row.README.md,docs/guides/getting-started.md(whose Inspect The Hook section becomes Trust The Hook),docs/guides/managing-installation.md,docs/compatibility.md, anddocs/reference/hooks.mdnow reference it instead of requiring it; the Hook Reference stays the canonical rendering of the checked-in commands./hookstrust step (routing begins after it) and the Windows status; the Getting Started guide drops the test-repository precondition and the#inspect-the-hookanchor; Managing an Installation says that disabling or removing Axiom leaves route-written Git state in place.docs/compatibility.mdstates that neither host has a recorded Windows observation, how the CI job exercises the Hook commands on Windows, and the PowerShell fallback.Repository policy revision 119 records the change in the ledger; the plugin version and runtime contract digest are unchanged.
Affected files and surfaces
README.md,docs/trust-model.md,docs/guides/getting-started.md,docs/guides/managing-installation.md,docs/compatibility.md,docs/reference/hooks.md;evidence/repository-policy-revisions-v1.json,evidence/runtime-identity.json,evidence/release-status.json,docs/runtime-identity.md,docs/repository-policy-revisions.md(revision 119)Routing and authorization impact
Documentation
The trust model owns the write-location disclosure and the optional verification; the install and update guides, the README, the compatibility reference, and the Hook Reference link to it. Installation and hook commands are unchanged.
Validation
python3 -B scripts/check-publication.pypython3 -B -m unittest discover -s tests -p 'test_*.py'git diff --check#inspect-the-hookanchor in the repository.Cross-platform parity
Unrelated work