Repository navigation
docs: fix quick start prerequisites - #289
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe README Quick Start now lists Go and Node.js/npm prerequisites. It replaces ChangesQuick Start instructions
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other · Severity of issue fixed: Low Suggested reviewers: Merge Risk: ⚪ Minimal · up to The Quick Start describes the checked-in setup path and its prerequisites; no actionable issue remains to resolve before merging. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
🧹 Preview removed because the pull request was closed. |
vedant21-ctr
left a comment
There was a problem hiding this comment.
A few small changes :
-
Fix the prerequisites formatting:
**Prerequisites:**is currently inside the>blockquote, while the list is outside it. This also causes the prerequisite heading to run together with the preceding paragraph. Please keep the existing quote unchanged and place the prerequisites under a separate bold line/subheading after a blank line. -
Remove the extra blank line at the beginning of the
bashcode block that was left after removinggo mod tidy. -
Update the
make setupcomment:# Install necessary tools and modulesis slightly misleading becausemake setuponly runsnpm install. Something like# Install Node dependencies (including the local Hugo binary)would be clearer. -
Unrelated formatting changes: the Publishing indentation and
*→-changes in Helpful Resources are outside the scope of #287. Please either revert these unrelated changes or mention them in the PR description.
Signed-off-by: Tejas <tamhanetejas92@gmail.com>
2070e48 to
55269fb
Compare
|
@vedant21-ctr check I have reverted back all unnecessary changes plz review |
Summary
This PR fixes the Quick Start (Local Preview) documentation.
Changes:
academy-theme.go mod tidystep.Closes #287
Summary by CodeRabbit
go.mod, and the recommendation to use Node.js 22.