docs: clarify DevContainer onboarding flow

[Kiran-Sarwar]

Summary

Updated the README Quick Start section to align with the Makefile onboarding guidance.

Issue: Fixes #70

Change Type

• Bug fix
• New feature
• Breaking change
• Documentation update
• Dependency update

Validation Evidence

Reviewed the updated README to ensure the Quick Start instructions now match the Makefile onboarding guidance.

Validation performed:

• Confirmed the README clearly instructs users to open the project in a Dev Container before running make commands.
• Confirmed the README and Makefile onboarding instructions no longer conflict.

Risk and Rollback

• Risk level: Low
• Rollback plan: Revert the README changes if any issues are identified.

Checklist

• Scope is focused and minimal
• Tests and/or checks relevant to this change were executed
• Docs were updated when behavior changed
• No secrets or sensitive data were added
• I verified spelling and basic formatting

Summary by CodeRabbit

• Documentation
  • Updated the Quick Start instructions with a clearer, reordered onboarding sequence.
  • Separated repository cloning from bootstrapping, renumbered subsequent setup steps, and added a dedicated step for opening the project in a Dev Container.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5f06fb09-f42d-4d39-97c8-f9c3dc56bfe4

📥 Commits

Reviewing files that changed from the base of the PR and between fb38e98 and a78c55a.

📒 Files selected for processing (1)

• README.md

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README Quick Start flow now separates repository cloning, Dev Container setup, and bootstrapping, then renumbers environment setup and local infrastructure startup steps.

Changes

Onboarding documentation

Layer / File(s)	Summary
Quick Start step sequence README.md	Separates cloning, Dev Container setup, and bootstrapping, and renumbers environment variable setup to step 4 and local infrastructure startup to step 5.

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

Suggested reviewers: ulises-jeremias

🚥 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 describes the documentation update about Dev Container onboarding.
Linked Issues check	✅ Passed	README now recommends the Dev Container, keeps the fallback workflow, and stays documentation-only.
Out of Scope Changes check	✅ Passed	The PR is limited to README wording and onboarding flow clarification.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

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 `@README.md`:
- Around line 90-98: Update the README environment guidance around “Open the
project in a Dev Container” and the manual uv setup section so it is consistent:
either remove the manual setup instructions or explicitly label them unsupported
and outside the documented development flow, while preserving the Dev Container
as the supported path.

🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 94578248-a2a8-4baa-b853-e62af2124d5c

📥 Commits

Reviewing files that changed from the base of the PR and between 6b187e5 and fb38e98.

📒 Files selected for processing (1)

• README.md

[ulises-jeremias]

Thanks for the contribution. I would not merge this as-is because the README now says the project only supports development inside a Dev Container. The repository guidance is DevContainer-first, but external contributors can still use the documented local checks when available.

Could you please soften this wording to something like “Recommended: open the project in the Dev Container before running make commands” and keep the non-DevContainer fallback clear?

[Kiran-Sarwar]

Thanks for the detailed feedback! That makes sense. I'll update the wording to recommend using the Dev Container while keeping the non-DevContainer workflow clear. I'll push an update shortly.