README: lead with the run command, move Questions below the primer - #4
Merged
Conversation
Put a yeet run block directly under the one-line definition so the command is visible without scrolling, and rename the lower install section to Get started. Questions this tool answers now sits after the sampling-profiler primer, so a reader has the vocabulary before the questions use it. Contents updated to match.
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.
Four README changes, all structural. No prose was rewritten.
Lead with the run command. A
yeet runblock now sits directly under the one-linedefinition, so the command a reader came for is visible without scrolling past the badges,
the GIF and four paragraphs of positioning.
Questions this tool answersmoved below the primer. It previously ran beforeA 60-second primer on sampling profilers, which meant the questions used self time,on-CPU and cgroup-scoped before the primer defined them. Reversing the two lets the
questions lean on vocabulary the reader already has.
Lower install section renamed
Get started. The hero block takes theQuick startname;
Get startedkeeps the manual-install link, the build-in-place instructions and theflag table.
Contents updated.
Quick startis dropped from theRun itrow (the hero block sitsabove the Contents, so an up-link to it is noise) and
Get startedtakes its place. The"Prefer to drive it yourself? Quick start is three lines" pointer under
Have an agent set it upwas repointed to#get-started— it describes the three-lineblock with the manual-install link, not the new two-line hero.
Rendered locally through GitHub's markdown API to confirm section order and that no
anchor was orphaned.