Repository navigation
Make the README work for a stranger: quick start, diagrams, hero banner - #3
Merged
Merged
Conversation
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.
The README had no way for a stranger to run the project (it never said where to get the
data) and the diagrams were plain. Someone landing on the repo should understand what
it is and get it running in a few minutes.
This adds a quick start with the real output of a clean run, a hero banner with badges,
and the agent loop diagram. The data model diagram is redrawn from the real schema,
with a card per table that links to its model file. Each diagram has a text version for
screen readers and search. The status and roadmap now say lesson 1 is done, and the
repo description and topics are set on GitHub.
CLAUDE.md also records two working rules: GitHub is the source of truth (a workflow
mirrors it to GitLab, so merge here only), and gem-gap findings go into a dated log.
Docs only, no app code changes. The diagrams were rendered and checked locally, and the
quick start output comes from a fresh db:reset, import, scenarios and rspec run.