docs: improve README with badges, TOC, and quick start#691
Open
Gingiris wants to merge 1 commit intothunderbird:mainfrom
Open
docs: improve README with badges, TOC, and quick start#691Gingiris wants to merge 1 commit intothunderbird:mainfrom
Gingiris wants to merge 1 commit intothunderbird:mainfrom
Conversation
Author
|
Hi there! 👋 Just checking in — if you have a chance to review this, I'd appreciate any feedback. Happy to adjust anything based on your preferences! |
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.
What this PR does
Improves the README with better discoverability and onboarding experience.
Why
docs/development.mdjust to find how to run the project. A Quick Start section with actual commands (make setup,bun dev, etc.) reduces time-to-first-run from minutes to seconds.Changes
docs/development.mdand verified againstMakefile,.env.example, andpackage.json)All existing content is preserved — these are purely additive changes.
🤖 This PR was created with AI assistance and reviewed by a human.
Note
Low Risk
Documentation-only updates to
README.mdthat don’t affect runtime behavior; risk is limited to potential onboarding inaccuracies if commands/prereqs drift from the codebase.Overview
Adds additional GitHub badges (license, last commit, stars) to improve project visibility.
Introduces a Table of Contents, a Quick Start section with prerequisites and local run commands, and a scannable Features table to improve first-run onboarding and discoverability.
Reviewed by Cursor Bugbot for commit 9edb07e. Bugbot is set up for automated code reviews on this repo. Configure here.