docs: fix dev script and tidy up README wording#316
Conversation
commit: |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates README.md documentation across multiple sections. The changes clarify DevTools UI features including violation card controls, highlighting behavior, and a new dedicated Auto-Scan constant scanning mode subsection. Configuration option descriptions for Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
🔗 Linked issue
N/A (small docs-only fixes, no issue needed.)
📚 Description
I was reading through the README and spotted a handful of small things, so I grouped them into one docs PR.
The main one is a broken command: the Development section tells you to run
pnpm dev:build, but that script doesn't exist in package.json, copy-pasting it just errors. The actual build script ispnpm build, so I fixed that.The rest are wording cleanups in line with the docs style guide:
Plus two cosmetic nits: a double space in one heading and an inconsistent "Scroll-to-element" spelling.
Docs only, no behaviour changes.