Skip to content

docs(phase-00/01): add cargo init step to dev environment lesson#322

Open
vasifsy wants to merge 1 commit into
rohitg00:mainfrom
vasifsy:add-cargo-init-phase0-dev-environment
Open

docs(phase-00/01): add cargo init step to dev environment lesson#322
vasifsy wants to merge 1 commit into
rohitg00:mainfrom
vasifsy:add-cargo-init-phase0-dev-environment

Conversation

@vasifsy

@vasifsy vasifsy commented Jul 4, 2026

Copy link
Copy Markdown

What this PR does

Adds a cargo init --vcs none step to Step 4 (Rust) of the Phase 0 dev environment lesson, so learners initialize a Cargo project right after installing the toolchain and can build/run Rust lessons with cargo.

This should address #259

Kind of change

  • Fix to an existing lesson

Checklist

  • Code runs without errors with the listed dependencies (cargo init verified locally on a fresh clone)
  • One lesson per commit (atomic per-lesson rule)
  • Tested locally / code output matches what docs/en.md claims

Phase / lesson

Phase 0 · 01-dev-environment

Notes for reviewer

target/ and Cargo.lock are already covered by the repo .gitignore. The instruction uses --vcs none so cargo skips its git integration and leaves the learner's local .gitignore untouched.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This change adds a documentation step in the Rust setup section instructing readers to run cargo init in the course repository root, with a new shell command block.

Changes

Documentation update

Layer / File(s) Summary
Cargo init instruction added
phases/00-setup-and-tooling/01-dev-environment/docs/en.md
Adds a new instruction and bash code block for initializing a Cargo project via cargo init in the Rust setup step.

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

Suggested reviewers: rohitg00

Poem

A rabbit hops to Rust's front door,
With cargo init, one step more,
A tiny line, a bash command,
Guiding coders hand in hand,
Docs now clearer than before! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately summarizes the main change: adding a Cargo init step to the dev environment lesson.
Description check ✅ Passed The description matches the change set by explaining the new Cargo init step in the Rust setup lesson.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@phases/00-setup-and-tooling/01-dev-environment/docs/en.md`:
- Around line 106-110: The Rust setup instructions currently use cargo init
without accounting for its default VCS side effects. Update the guidance in the
dev-environment docs to reference cargo init with --vcs none, or explicitly
mention the generated learner-local .gitignore behavior, so the initialization
remains clean and deterministic. Keep the fix focused on the setup step
described by cargo init in the docs entry.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 96fd1f6d-414b-4a3b-854e-6a0909db57ab

📥 Commits

Reviewing files that changed from the base of the PR and between c8b9b92 and 5772e81.

📒 Files selected for processing (1)
  • phases/00-setup-and-tooling/01-dev-environment/docs/en.md

Comment thread phases/00-setup-and-tooling/01-dev-environment/docs/en.md Outdated
@vasifsy vasifsy force-pushed the add-cargo-init-phase0-dev-environment branch from 5772e81 to 80242f4 Compare July 4, 2026 02:00
@vercel

vercel Bot commented Jul 4, 2026

Copy link
Copy Markdown

@vasifsy is attempting to deploy a commit to the OSS program Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant