Rewrite README against the script-readme-rules skill - #2
Merged
Conversation
The previous README was written by hand against the sigwire shape without
loading the skill, and missed most of it.
Added: 'Questions this tool answers' (9, after the primer per the CLI variant),
which was the single largest gap; a 60-second wire-protocol primer the 'shape'
vocabulary depends on; an agent setup prompt with the demo-traffic step; a
'Reading it without a TTY' section documenting the headless probe; a Contents
block; and a details block for the (pid, requestID) correlation rationale.
Reshaped: the one-sentence definition now names the category rather than
opening with the mechanism, and deliberately avoids redissnoop's noun
('profiler') so the two documents do not compete for one query. All five badges
are linked with descriptive alt text instead of one. The sample output gained a
column-meaning table. 'Testing across kernels' now leads with the fact that
motivates it and cites the real iov_iter rename the matrix caught.
Removed: 17 in-sentence em-dashes; 'Honest caveats' became 'What it can't see';
'Community questions' became 'FAQ', trimmed to five and deduplicated against
the questions section; the License section is two words with no SEC("license")
explanation.
Deliberately absent: no 'make veristat' section. The CLI template calls for one
but this Makefile defines only all/bpf/bundle/postgen/clean. sigwire's README
documents those targets anyway, which is a bug there worth fixing separately.
All 16 internal anchors verified against the headings.
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.
The previous README was written by hand against the
sigwireshape without loading thescript-readme-rulesskill. This rewrites it to the CLI variant.Reviewer action items
LICENSEfile. The README states Dual BSD/GPL, grounded in the BPF program'sSEC("license"), which covers the program rather than the repo.sigwirehas the same gap, so confirm whether a root LICENSE is the yeet-src conventionmainis currently redAbout description
(104 characters.)
Topic tags
Apply one per line, per the logedex mangling incident:
What changed
Added
## Questions this tool answers, 9 questions placed after the primer per the CLI variant. The single largest gap: the previous README had no equivalent section. Personas confirmed as debugging, performance; SRE, platform, DevOps and network were deliberately dropped rather than answered with hedges.## A 60-second primer on the MongoDB wire protocol, which the "query shape" vocabulary depends on.## Have an agent set it up, including the demo-traffic step and the "it compiled is not it works" line.## Reading it without a TTY, documenting theimport.meta.mainheadless probe.## Contents(four-row CLI split), and a<details>block for the(pid, requestID)correlation rationale.Reshaped
redissnoop's noun ("profiler") so the two documents don't compete for one query.## What you're looking atwith a column-meaning table.## Testing across kernelsleads with the fact that motivates it and cites the realiov_iter.iov→__iovrename the matrix caught in Fix build and verifier load on kernel 6.1 #1.Removed
## Honest caveats→## What it can't see.## Community questions→## FAQ, trimmed to exactly five and deduplicated against the questions section.## Licensesection is two words, with noSEC("license")explanation.Flagged claims
One deliberate omission
No
make veristat/make veristat-matrixsection. The CLI template calls for one, but this repo's Makefile defines onlyall,bpf,bundle,postgen,clean.sigwire's README documents those targets anyway, which is a bug in that README rather than something to propagate here. Worth either adding the targets to the template Makefile or fixing sigwire separately.All 16 internal anchors verified against the actual headings.