Fix make init statements in README#2547
Merged
ctauchen merged 1 commit intotigera:mainfrom Feb 24, 2026
Merged
Conversation
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository README quick-start instructions to reflect the correct native setup steps (Node via nvm + Corepack) and to adjust guidance around dependency installation when using make targets.
Changes:
- Replaces the README “Native” quick-start step from
make inittonvm use && corepack enable. - Removes
make initfrom the “Build and development commands” table. - Updates the note to state dependencies are installed automatically when running build/start commands and that switching modes triggers
manual-clean.
Comments suppressed due to low confidence (1)
README.md:75
- The
make inittarget still exists (and is a prerequisite formake start/make build), but it’s no longer listed in this command table. Consider adding it back with an accurate description (e.g., installs dependencies viayarn installand manages local vs containerized state) so users can run dependency setup explicitly.
## Build and development commands
| Command | Description |
|---|---|
| `make start` | Dev server at localhost:3000 (released versions only) |
| `make start-next` | Dev server including unreleased "next" docs |
| `make build` | Full production build |
| `make build-next` | Full build including unreleased docs |
| `make serve` | Build and serve the production site |
| `make serve-next` | Build-next and serve |
| `make clean` | Remove build artifacts |
| `make manual-clean` | Nuclear clean: removes `node_modules`, `.yarn`, `.docusaurus`, `build` |
| # Native | ||
| make init # Enables Corepack and runs yarn install | ||
| nvm use && corepack enable | ||
| make start # Dev server at http://localhost:3000 |
There was a problem hiding this comment.
In the quick-start snippet, make start will run init (and thus yarn install), but that’s not obvious from the steps anymore. Suggest adding a brief note here (or include an optional make init step) so readers understand dependency installation will happen when make start runs.
Suggested change
| make start # Dev server at http://localhost:3000 | |
| make init # Optional: installs dependencies (corepack + yarn install) | |
| make start # Runs init on first run, then dev server at http://localhost:3000 |
| All commands support `CONTAINERIZED=true` for Docker-based builds (e.g., `make build CONTAINERIZED=true`). | ||
|
|
||
| > **Note:** When switching between native and containerized builds, the `init` target automatically detects the change and runs `manual-clean` for you. | ||
| > **Note:** Dependencies are installed automatically when you run any build or start command. When switching between native and containerized builds, the build system detects the change and runs `manual-clean` for you. |
There was a problem hiding this comment.
This note says dependencies are installed automatically when you run “any build or start command”; since the README mentions using yarn directly, this could be misread as applying to yarn build/start too. Consider clarifying that this auto-install behavior is for the make targets (e.g., make start, make build, etc.).
Suggested change
| > **Note:** Dependencies are installed automatically when you run any build or start command. When switching between native and containerized builds, the build system detects the change and runs `manual-clean` for you. | |
| > **Note:** For the `make` targets listed above (for example, `make start`, `make build`, `make serve`), dependencies are installed automatically when you run a build or start command. This does not apply to running Yarn scripts directly (such as `yarn start` or `yarn build`), which still require `yarn install` after `corepack enable`. When switching between native and containerized builds, the build system detects the change and runs `manual-clean` for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Product Version(s):
Issue:
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: