Repository navigation
docs: guide README readers from use case to architecture - #23
Merged
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
The README introduced internal components and test inventories before showing an end-to-end use case. Both language versions now follow the same reading path:
Keep the protocol, online engine and offline harness visible in the framework diagram. Move detailed suite commands and contracts behind existing documentation links, retain material trust limits, and link a verified PR/main run as a concrete example. Only README.md and README.zh-CN.md change.
Evidence
python -m examples.github_release_gateprints False / True / False as documented;python -m sacp_harnessreports 8/8 breakers, 3/3 positive controls and 49/49 strict-valid documents. Both commands exit 0.python .local/check-docs.pyandgit diff --checkpass. The linked historical main run was freshly checked: success at 48ba192.Review at base
48ba19209b7ea6f9d833193f92319cee0eed291a, headf5f9f48dc5e79d3db6e398612607a53bd07e3113: no blocking findings. Bilingual chapter order and diagrams match; the diagram separates protocol validity, runtime projection and offline evaluation. Example outcomes and limits match implementation. PR CI 38677927509 passed all eight required jobs. Receipt 38677993395 is COMPLETE/200, strict PASS, bound to this head, with no policy warnings or evidence errors. Proceed with manual squash merge at this head and inspect the resulting main verification.Post-merge: main
e4dd99c292ae797b0e7e4e0a86c75fc1c8e5acbb, run 38678076325, all seven jobs success. Downloaded all six suite artifacts and receipt; verified exact counts, zero failures/errors/skips, SHA/run binding and independently recomputed tree fingerprint. Main receipt COMPLETE/200, strict PASS. No branch deletion.Merge Danger
Door: two-way
Documentation-only changes can be reverted in a subsequent PR.
Blast Radius: documentation
Review bilingual consistency, runnable commands, links, diagram relationships and public claim boundaries. Actual fork E2E remains unverified; writer authentication and side-effect execution stay with integrations.