docs(readme): quickstart rewrite with numbered steps and v0.1.0 release (#454)#465
docs(readme): quickstart rewrite with numbered steps and v0.1.0 release (#454)#465
Conversation
…out (#454) - Add prerequisite callout (API key warning) immediately after badges - Rewrite Quick Start as 5 numbered steps: install, API key, init, think, build/prove/ship - Add uv run cf --help smoke test to step 1 - Use uv run cf prefix throughout quickstart for reliability without venv activation - Add uv run prefix guidance note at top of CLI Reference section
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughREADME updated to add a prominent Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 12-13: The blockquote starting with the line beginning "⚠️
**Prerequisite:** CodeFRAME requires an `ANTHROPIC_API_KEY`..." contains a blank
line that triggers markdownlint MD028; remove the empty blank line inside that
blockquote or replace it with a single '>' line to preserve spacing (i.e.,
ensure every line inside the blockquote begins with '>' so the blockquote has no
true empty lines) so the blockquote no longer violates the no-blanks-blockquote
rule.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Summary
Closes #454. Fixes the new-user experience by restructuring the Quick Start and making the API key requirement impossible to miss.
Changes
README.md
API key prerequisite callout — Added immediately after the badge row, before "The Problem". New users see it before reading anything else.
Quick Start rewritten as 5 numbered steps:
uv run cf --helpuv run cf init /path --detect)uv run cf prd generate+cf tasks generate+cf tasks listCLI Reference note — Added
uv runguidance at the top of the section so users don't get confused if their venv isn't active.GitHub Release
v0.1.0 pre-release created (matches
pyproject.tomlversion) with quickstart in release notes — will be created after merge.Acceptance criteria
git clone + uv sync(notpip install)Test plan
uv run cf --helpworks)Summary by CodeRabbit