Repository navigation
refactor(web): remove and correct stale comments in the site and videos - #183
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 33 minutes. View limit details
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 |
|
React Doctor found no new issues. 🎉 Reviewed by React Doctor for commit |
|
The latest Docker Doctor scan for this pull request. Learn more about Docker Doctor.
Score: 84 / 100 · 3 issues
Scanned by Docker Doctor for commit |
commit: |
Sixteen comments in apps/web repeated the code under them: `// cached forever` above `revalidate = false`, a label above a CSS variable group, a sentence restating a one-line helper. The badge route also pointed at a note in core's scoring.ts that is not there.
sidebar.tsx said every page-tree node carries a `$id`, while the code falls back when it is missing. source.config.ts said some docs use fence labels such as `384:401:path`. None does today, and the normalizer stays for any that will.
The compositions marked each scene with a `// ─── Scene ───` banner above a component that already names the scene. remotion.config.ts kept Remotion's scaffold header, and its rule guard restated itself.
- index.css said the video is always dark, with the dark values baked in. The `@theme` block holds the light values, and `.dark` is a block of its own. - The ComposeAgents header said nothing fades. MonoCaption fades in. - The sound comment named scripts/make-sfx.py and two accents. The script is make-sfx.ts and it makes three. - The chrome comment listed crosshairs. Only the marquees ride above the scenes.
00ffb11 to
3243ff5
Compare
Description
The comment audit for the website and the release videos. This PR removes comments that repeat the code and corrects six that are wrong. No code, markup or CSS rule changes.
Four commits:
// cached foreveraboverevalidate = false(twice), "Global Scrollbar Colors" above the scrollbar variables (twice), sentences that restate one-line helpers, a scaffold doc link, and a badge-route comment pointing at a note in core'sscoring.tsthat is not there.sidebar.tsxsaid every page-tree node carries a$id, while the code falls back when it is missing.source.config.tssaid some docs use384:401:pathfence labels. None does today, and the normalizer stays for any that will.// ─── Scene ───banners above components that already name the scene, and Remotion's scaffold header inremotion.config.ts.index.csssaid the dark values are baked in. The@themeblock holds the light values.MonoCaptionfades in.make-sfx.pyand two accents. The script ismake-sfx.tsand makes three.Kept: accessibility and design notes, the fumadocs and Shiki facts, the hydration notes, and the creative direction in the compositions.
Related Issues
N/A. Found by a comment audit of the repository.
Checklist
Screenshots (if applicable)
N/A. No rendered output changes.
Additional Notes
globals.css(lines 85 and 159) reads as garbled, but the intended wording is yours to pick.