docs: close the README with an overview instead of a stage section - #48
Merged
Conversation
Every commit so far rewrote "## This stage —" to describe the one capability it added. At the tip that section is the wrong shape: a reader arriving at the head of the branch wants to know what the device ends up doing and what the whole thing cost, not what the last commit changed about it. It becomes "## Where it ends up" — the record the device actually sends, with its four SD elements, mutual TLS and AES-256-GCM store; the generated total; and an instruction to read the history forward from the Baseline commit rather than to treat the tip as the product. That instruction is the point of the repository: the diff is what a reader applies to their own build, so the sequence is the deliverable and the tip is only where it happens to stop. The STAGE-COST block stays where it was, so the headline figure is still written by scripts/gen-cost-table.py from measurements/aes-gcm.csv. The minimum useful cost is pointed at rather than quoted — it is already a row in the table below, and a figure written into prose here would go stale silently the first time anything moved. No stage row, no CSV, and run-report.md is untouched: nothing here reaches the binary, so there is no measurement to take.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README’s stage-3 narrative now describes the resulting RFC 5424 record, mutual TLS delivery, encrypted local spooling, and sequential interpretation from the Baseline commit. The existing Flash and RAM cost values remain unchanged. ChangesREADME stage update
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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.
Pull request
What this stage adds
Every commit so far rewrote "## This stage —" to describe the one capability it
added. At the tip that section is the wrong shape: a reader arriving at the head
of the branch wants to know what the device ends up doing and what the whole
thing cost, not what the last commit changed about it.
It becomes "## Where it ends up" — the record the device actually sends, with its
four SD elements, mutual TLS and AES-256-GCM store; the generated total; and an
instruction to read the history forward from the Baseline commit rather than to
treat the tip as the product. That instruction is the point of the repository:
the diff is what a reader applies to their own build, so the sequence is the
deliverable and the tip is only where it happens to stop.
The STAGE-COST block stays where it was, so the headline figure is still written
by scripts/gen-cost-table.py from measurements/aes-gcm.csv. The minimum useful
cost is pointed at rather than quoted — it is already a row in the table below,
and a figure written into prose here would go stale silently the first time
anything moved.
No stage row, no CSV, and run-report.md is untouched: nothing here reaches the
binary, so there is no measurement to take.
Files
Checklist
measurements/docs-overview.csvcommitted. — not in this diffmeasurements/stages.tsv. — not in this diffpython3 scripts/gen-cost-table.py../run.shgreen (build + QEMU + baseline self-check) —run-report.mdcommitted. — not in this diffContext for review: 21 of 21 sequential single-commit PRs replaying the integration on top of the Baseline root. Each lands green and reviewed before the next is built on it, because a change to an early commit would force every commit above it to be re-run and re-measured.
Summary by CodeRabbit