docs: sharper positioning — explain wiki-trace in 60s#11
Merged
Conversation
Two issues with the previous README:
1. "wiki-trace" carries the wrong association. Anyone landing cold
thinks Wikipedia / knowledge base before they get to LLM tracing.
The hero badges were strong but the first prose section ("What it
is") opened with abstract framing.
2. The README had two near-identical sections ("What it is" and "Why
wiki-trace") making the same point twice. Cut one, sharpened the
other.
What changed
- Renamed "What it is" to "In one minute" and rewrote it as
problem -> why existing tools fail -> what we do differently, with
the one-line patch() example inline so the value is concrete by
paragraph 4.
- Added a brief "Heads up on the name" callout. Honest about the v0.1
legacy. Keeps the GitHub URL stable while telling readers the name
is a codename, not the product.
- Dropped the redundant "Why wiki-trace" bullet list. Same content
was already covered by the badges + In one minute section.
Net effect: someone landing on the repo cold gets the elevator pitch
in the first 50 lines without having to scroll past badges + ToC +
abstract intro before reaching the value prop.
No code changes. README only.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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.
Replaces the abstract 'What it is' opener with a concrete 'In one minute' section that goes problem → why existing tools fail → patch() example. Adds an honest callout that 'wiki-trace' is a v0.1 codename. Drops the redundant 'Why wiki-trace' section.
No code changes.