docs: make README beginner-first with quickstart and troubleshooting#24
Merged
docs: make README beginner-first with quickstart and troubleshooting#24
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
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.
Why
The README had strong content, but new users had to scan multiple sections before getting a reliable first success. This PR optimizes for a beginner-first setup flow.
What Changed
Start Here (2 to 5 minutes)section with copy/paste commands.Prerequisites,Install, andVerify It Worked.command not found, changes not applying, doctor issues).Common Taskswith clearer labels.Advanced Notesto reduce initial cognitive load.Scope
README.md)Reviewer Checklist
Start Hereblock in order and confirm it reads clearly for first-time users.boo theme,boo opacity,boo prompt,boo doctor,boo reload).Testing
Follow-Up Ideas (separate PR)
boo statusand a theme switch.