docs/ci: complete README file reference and add readme-sync guard#29
Conversation
It was listed in docs/INSTALLATION.md but missing from the README optional-files table, leaving it invisible to anyone doing a quick file-reference scan. https://claude.ai/code/session_01HXBTBxk2YTCvs62tE3Qm28
Quick start: add slashed-utilities-viewport.css and slashed-animations.css alongside slashed-utilities-visual.css so all opt-ins are visible. File reference: add missing optional files (slashed-animations.css, tokens-legacy.css, tokens-user.example.css) and missing docs entries (TOKENS.md, UTILITIES.md, UTILITIES-VISUAL.md). https://claude.ai/code/session_01HXBTBxk2YTCvs62tE3Qm28
bin/check-readme-sync.sh: fails if any css/*.css or docs/*.md file is not mentioned by name in README.md. Catches the class of drift that accumulated (slashed-utilities-viewport.css, TOKENS.md, etc.) without any automated guard to catch it. .github/workflows/bundle-check.yml: new readme-sync job runs the script on every push and PR. bin/setup-hooks.sh: pre-commit hook now also blocks commits that add a new css/*.css or docs/*.md without staging README.md, prompting the author to update the File reference section before committing. https://claude.ai/code/session_01HXBTBxk2YTCvs62tE3Qm28
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA new verification system ensures that all CSS and documentation files are referenced in the README. It includes a pre-commit hook guard, a verification script invoked by both the hook and CI, and documentation of additional CSS bundles. ChangesREADME Sync Verification System
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error, 1 warning)
✅ Passed checks (6 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@bin/setup-hooks.sh`:
- Around line 76-77: The git command that builds new_files uses --diff-filter=A
which omits renamed files; update the filter in the pipeline that sets new_files
(the git diff --cached --name-only --diff-filter=... call) to include renames
(R) as well as added files so renamed CSS/docs are captured (e.g. use AR or a
combined filter like --diff-filter=AR), keeping the rest of the pipeline (the
grep for '^(css/[^/]+\.css|docs/[^/]+\.md)$' and the || true fallback)
unchanged.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 99bae939-0db7-40d9-97b1-dd13e327f044
📒 Files selected for processing (4)
.github/workflows/bundle-check.ymlREADME.mdbin/check-readme-sync.shbin/setup-hooks.sh
--diff-filter=A misses renames (git reports them as R, not A). Changing to AR ensures the guard triggers when a css/*.css or docs/*.md file is renamed and README.md isn't staged alongside it. https://claude.ai/code/session_01HXBTBxk2YTCvs62tE3Qm28
2 participants
Summary
slashed-utilities-viewport.css,slashed-animations.css,tokens-legacy.css,tokens-user.example.css) and missing docs entries (TOKENS.md,UTILITIES.md,UTILITIES-VISUAL.md) to the File reference section; updated Quick start opt-ins block to list all three add-on filesbin/check-readme-sync.sh— new script that fails if anycss/*.cssordocs/*.mdfile is not mentioned by name inREADME.md.github/workflows/bundle-check.yml— newreadme-syncCI job runs the script on every push and PRbin/setup-hooks.sh— pre-commit hook now also blocks commits that add a newcss/*.cssordocs/*.mdwithout stagingREADME.mdTest plan
bin/check-readme-sync.shexits 0 on the current treereadme-syncjob passes.cssfile without updatingREADME.mdand trying to commit is blocked by the pre-commit hook (after runningbin/setup-hooks.sh)https://claude.ai/code/session_01HXBTBxk2YTCvs62tE3Qm28
Generated by Claude Code
Summary by CodeRabbit