Restructure README for information hierarchy (TL;DR-first)#23
Merged
Conversation
Not a rewrite — a reorder for how info lands on first read. After the hero (mascot + agentic-loop image), lead with the result, not the problem: - New TL;DR: the punchline + the measured win (-56% files / -12% tokens / -20% time) up top. - 'What it gives you': 4 scannable headline bullets (map / reuse-first / self-maintaining / any agent). - Quick jump links (How it works · numbers · setup). - Demote the problem narrative under '## The problem it solves' (context, not the opener). - Rename the detailed lower list to 'In the box (full detail)' — the less-imp inventory stays, below the fold. Applies the copy-editing 'lead with the outcome / front-load' sweep.
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.
Reorder (not rewrite) so the benefit/result lands immediately after the mascot + diagram, per the inverted-pyramid / front-load principle:
So: TL;DR → what it enables → important → less important. Docs-only; no version change.