docs: Improve README and documentation clarity#9
Merged
dylanburkey merged 1 commit intodevfrom Feb 23, 2026
Merged
Conversation
- Rewrite README.md with scenario-based structure - Add clear paths: new project, existing project, multi-model only - Add 'Common Workflows' section with real examples - Add quick reference tables for commands - Create docs/QUICKSTART.md for ultra-fast getting started - Rewrite getting-started.md with 'What are you trying to do?' approach - Remove marketing fluff, focus on practical usage - Add comparison table vs Cursor/Copilot
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.
Summary
Complete rewrite of README.md and key documentation to make it clearer how to use Claude Code Sidekick in different scenarios.
Changes
README.md
docs/QUICKSTART.md (NEW)
docs/guides/getting-started.md
Before/After
Before: Wall of marketing text, features listed but not actionable
After: 'I want to X' → 'Do Y' format, immediately useful