docs: overhaul README with clearer setup steps and updated terminology#36
Merged
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Setup guide: - Restructure from 3 sparse steps to 7 self-contained steps with clone commands, extension install, housekeeping, and file replacement - Expand UI library comparison with semantic token support details, theming tools for shadcn, and HeroUI agent skills - Add icon library reference for each UI choice Content and structure: - Move "Common Additions" section up into the main body - Update CI/CD diagram to include Vercel deployment status check and e2e status reporting back to the PR commit - Update config files table descriptions for commands/ and .mcp.json Terminology and cleanup: - Replace "branch protection" with "ruleset" across README and project-setup.md to match the actual GitHub rulesets API - Remove emoji prefixes from section headings - Replace 2 JPG images with PNG versions - Fix "Incldues" typo The setup section was too terse for someone arriving at the template fresh. The expanded steps and UI guidance reduce the gap between cloning and having a working project. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Summary by CodeRabbitRelease Notes
WalkthroughThe pull request removes WebFetch permissions for ten external domains from Claude settings, rewrites README setup instructions to include explicit git clone/npm install steps and extension installation guidance, adds a "Common Additions for New Projects" section, removes emoji prefixes from section headings, updates CI/CD documentation with Vercel deployment details and E2E test descriptions, and standardises branch ruleset terminology across documentation. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 28: README currently recommends deleting x_docs/ but still contains
internal links to x_docs/project-setup.md (e.g., the reference at Line 260)
which would break; update the README to include a short housekeeping note (or
checklist) that when removing x_docs/ you must also remove or update all links
to x_docs/* (specifically x_docs/project-setup.md) and scan other setup
references, or alternatively replace those links with their new destinations;
search for occurrences of "x_docs/project-setup.md" and "x_docs/" and
update/remove them accordingly.
- Line 28: Replace the awkward sentence "Recommended to remove
[x_docs/](x_docs/) (these are my working files)." in the README with an
idiomatic phrasing such as "It is recommended to remove [x_docs/](x_docs/)
(these are my working files)." or "I recommend removing [x_docs/](x_docs/)
(these are my working files).", and keep the rest of the sentence about
modifying "CLAUDE.md", ".mcp.json", and "commands/" intact; update the line in
README where that housekeeping step appears.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: a4ccaa9f-b2b4-46c0-a251-ddb29229c70a
⛔ Files ignored due to path filters (4)
x_docs/images/explained.jpgis excluded by!**/*.jpgx_docs/images/rough-notes.pngis excluded by!**/*.pngx_docs/images/rough.jpgis excluded by!**/*.jpgx_docs/images/template-explained.pngis excluded by!**/*.png
📒 Files selected for processing (3)
.claude/settings.jsonREADME.mdx_docs/project-setup.md
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
Test plan
🤖 Generated with Claude Code