Rebuild the front page around what a reader needs first - #40
Merged
Conversation
The README was 651 lines and 277 of them were verification detail sitting
between the quick start and any explanation of what the tool does. A reader
met a treatise on checking evidence before learning what produced it.
Order is now: the two hard limits, what it does, quick start, a short section
on checking the evidence, then limits and architecture. Depth moved out
verbatim rather than being rewritten:
docs/verification.md the bundled and independent verifiers, key pinning,
the conformance corpus, and what verification does
not prove
docs/reference.md the HTTP API, configuration keys, and a worked
policy decision
Nothing was softened and no claim changed. Relative links inside the moved
content were rebased, since content written for the repository root resolves
differently one directory down.
651 lines to 348. Quick start verified from a clean tree.
Signed-off-by: reesebuilt <[email protected]>
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
1 participant
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.
651 lines, and 277 of them were verification detail sitting between the quick start and any explanation of what the tool does. A visitor met a treatise on how to check evidence before learning what produces it.
New order: the two hard limits, what it does, quick start, a short section on checking the evidence, then limits and architecture.
Depth moved out verbatim rather than rewritten, so nothing was softened and no claim changed:
docs/verification.md: both verifiers, key pinning, the conformance corpus, and what verification does not provedocs/reference.md: the HTTP API, configuration keys, and a worked policy decisionRelative links inside the moved content were rebased, because content written for the repository root resolves differently one directory down. The docs link gate catches that and did.
651 lines to 348. Quick start re-run from a clean tree: init and doctor both pass.