Skip to content

docs: fix quick start prerequisites - #289

Merged
banana-three-join merged 1 commit into
layer5io:masterfrom
Tejas123png:fix/istio-navigation-links
Oct 8, 2026
Merged

banana-three-join merged 1 commit into
layer5io:masterfrom
Tejas123png:fix/istio-navigation-links

Conversation

@Tejas123png

@Tejas123png Tejas123png commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This PR fixes the Quick Start (Local Preview) documentation.

Changes:

  • Added Go as a prerequisite because Hugo Modules requires it to fetch the academy-theme.
  • Added Node.js and npm as prerequisites for installing the local Hugo binary.
  • Removed the unnecessary go mod tidy step.

Closes #287

  • Yes, I signed my commits.

Summary by CodeRabbit

  • Documentation
    • Updated Quick Start prerequisites to include Go and Node.js/npm, noting Go’s role in Hugo Modules, the version requirement from go.mod, and the recommendation to use Node.js 22.
    • Reordered setup instructions to begin with installing Node.js dependencies and the local Hugo binary; removed the Go module cleanup and dependency-verification commands.

@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 0ae7047a-d07d-4db6-ba01-7b6cd0dd04d0
📥 Commits

Reviewing files that changed from the base of the PR and between 2070e48 and 55269fb.

📒 Files selected for processing (1)
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README Quick Start now lists Go and Node.js/npm prerequisites. It replaces go mod tidy instructions with Node dependency installation, including the local Hugo binary, before make setup.

Changes

Quick Start instructions

Layer / File(s) Summary
Clarify prerequisites and setup commands
README.md
The Quick Start explains that Go is needed for Hugo Modules and recommends Node.js 22. It replaces the go mod tidy commands with Node dependency installation, including the local Hugo binary, before make setup.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other · Severity of issue fixed: Low

Suggested reviewers: vedant21-ctr

Merge Risk: ⚪ Minimal · up to 55269

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)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: correcting the Quick Start prerequisites.
Linked Issues check ✅ Passed Issue #287 requires the Quick Start to identify Go as a Hugo Modules prerequisite and list only necessary initial setup commands. README.md now states that Go is required to fetch academy-theme, and…
Out of Scope Changes check ✅ Passed The README.md changes cover Quick Start prerequisites and setup commands. The Node.js/npm prerequisite supports installing the local Hugo binary. The whole-PR diff shows no unrelated publishing or res…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

🧹 Preview removed because the pull request was closed.

@vedant21-ctr vedant21-ctr left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small changes :

  1. 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.

  2. Remove the extra blank line at the beginning of the bash code block that was left after removing go mod tidy.

  3. Update the make setup comment: # Install necessary tools and modules is slightly misleading because make setup only runs npm install. Something like # Install Node dependencies (including the local Hugo binary) would be clearer.

  4. 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>
@Tejas123png
Tejas123png force-pushed the fix/istio-navigation-links branch from 2070e48 to 55269fb Compare October 7, 2026 11:46
@Tejas123png

Copy link
Copy Markdown
Contributor Author

@vedant21-ctr check I have reverted back all unnecessary changes plz review

@banana-three-join banana-three-join left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Ty!

@banana-three-join
banana-three-join merged commit ebe4e7b into layer5io:master Oct 8, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove or clarify go mod tidy from the Quick Start instructions

3 participants