README structural rewrite for promotion (PR A)#5
Merged
SwathiMystery merged 1 commit intomainfrom Apr 23, 2026
Merged
Conversation
Reorders and tightens copy for a promote-ready README. No asset changes.
Hero
- Promote the tagline to h3 italic so it dominates visually
- Drop the redundant sub-sub-tag ("Auto-capture facts and decisions as you work...") — already covered in banner
- Drop "PRs Welcome" badge (noise; CONTRIBUTING.md link suffices)
Flow
- Add a "60-second try" block immediately under badges so visitors who already "get it" can try in seconds
- Merge "What is lore?" + "The Problem" into a single "Why lore exists" section
- Move "What makes lore different" (comparison table) from the bottom to right after the Why section — strongest proof point, now visible without scrolling past the whole doc
- Drop the old top/bottom nav rows (redundant with GitHub TOC sidebar)
- Drop "Prerequisites" section (folded into Install)
Attribution and polish
- Testimonial attribution: "Claude Code power user" → "early user, 2026-04" (specific-but-anonymous)
- Add author line at the end ("Built by Swathi because she kept closing terminals...")
- New closing CTA: Star / pip install / Issues
- Changelog link surfaced in the alpha callout
Content preserved unchanged
- Banner image
- ASCII architecture diagram
- JSON decision-trace example
- Compiled article example
- Commands table
- Storage tree
- Three-layer model diagram
- Before/after table
- "What lore does NOT replace" list
Collaborator
Author
|
Pushed a follow-up fixing broken badges after review:
Also added Programming Language / License / OS / Topic classifiers to pyproject.toml — good PyPI hygiene. Takes effect on next release. |
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.
First of three planned README improvements (PR A: structure & copy; PR B: 15s asciicast; PR C: visual polish).
What changed
Hero
Flow
Attribution & polish
Preserved (no change)
Not in scope
Ready to merge once CI is green.