[feature] Added make html SKIP_YARN=1#171
Conversation
WalkthroughThis pull request introduces an optional Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@Makefile`:
- Line 46: Update the help echo string that currently shows "make SKIP_YARN=1
html" to match the README ordering by using "make html SKIP_YARN=1"; locate the
echo in the Makefile that prints the SKIP_YARN example and replace the example
command text only so both docs are consistent.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
MakefileREADME.rst
🔇 Additional comments (2)
Makefile (1)
29-52: SKIP_YARN gating looks solid.Defaulting to 0 preserves existing behavior, and the conditional cleanly skips
yarn buildwhen requested.README.rst (1)
28-30: Docs update is clear and helpful.The example accurately reflects the new SKIP_YARN behavior and provides good context for when to use it.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| @echo ' ' | ||
| @echo 'Set the DEBUG variable to 1 to enable debugging, e.g. make DEBUG=1 html ' | ||
| @echo 'Set the RELATIVE variable to 1 to enable relative urls ' | ||
| @echo 'Set the SKIP_YARN variable to 1 to skip yarn build, e.g. make SKIP_YARN=1 html' |
There was a problem hiding this comment.
Align the SKIP_YARN example ordering with README.
The help text uses make SKIP_YARN=1 html while README shows make html SKIP_YARN=1. Both work, but consistent ordering avoids confusion.
Suggested text tweak
- `@echo` 'Set the SKIP_YARN variable to 1 to skip yarn build, e.g. make SKIP_YARN=1 html'
+ `@echo` 'Set the SKIP_YARN variable to 1 to skip yarn build, e.g. make html SKIP_YARN=1'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| @echo 'Set the SKIP_YARN variable to 1 to skip yarn build, e.g. make SKIP_YARN=1 html' | |
| `@echo` 'Set the SKIP_YARN variable to 1 to skip yarn build, e.g. make html SKIP_YARN=1' |
🤖 Prompt for AI Agents
In `@Makefile` at line 46, Update the help echo string that currently shows "make
SKIP_YARN=1 html" to match the README ordering by using "make html SKIP_YARN=1";
locate the echo in the Makefile that prints the SKIP_YARN example and replace
the example command text only so both docs are consistent.
Added
make html SKIP_YARN=1.