Repository navigation
docs: simplify all project READMEs - #520
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.
Simplify all nine project READMEs around component purpose, protocol behavior, the shared transaction SVG, and brief usage guidance.
Remove code maps, file/directory inventories, RPC/API references, environment-variable catalogs, long configuration examples, and implementation walkthroughs. Keep role descriptions, proof composition and compatibility, deployment basics, local test coverage, and read-only operator-tool usage. The combined READMEs now total 402 lines.
Validation: local links and anchors, Markdown code fences, English-only text, syntax of 12 Bash examples, and
git diff --checkpassed. No runtime code changed or live deployment commands were executed.