Skip to content

docs(readme): quickstart rewrite with numbered steps and v0.1.0 release (#454)#465

Merged
frankbria merged 2 commits intomainfrom
docs/quickstart-and-v0-release
Mar 20, 2026
Merged

docs(readme): quickstart rewrite with numbered steps and v0.1.0 release (#454)#465
frankbria merged 2 commits intomainfrom
docs/quickstart-and-v0-release

Conversation

@frankbria
Copy link
Owner

@frankbria frankbria commented Mar 20, 2026

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

  1. API key prerequisite callout — Added immediately after the badge row, before "The Problem". New users see it before reading anything else.

  2. Quick Start rewritten as 5 numbered steps:

    • Step 1: Install (git clone, uv sync) + smoke test uv run cf --help
    • Step 2: Set API key (prominent, with link to console.anthropic.com)
    • Step 3: Initialize project (uv run cf init /path --detect)
    • Step 4: Think — uv run cf prd generate + cf tasks generate + cf tasks list
    • Step 5: Build/Prove/Ship — batch run + proof run + pr create
  3. CLI Reference note — Added uv run guidance 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.toml version) with quickstart in release notes — will be created after merge.

Acceptance criteria

  • README install instructions use git clone + uv sync (not pip install)
  • API key requirement is visible in the quickstart (Step 2, not buried)
  • 5-step quickstart shows the full Think → Build → Prove → Ship pipeline
  • Tagged v0.1.0 GitHub Release (created after merge)

Test plan

  • Quick Start commands verified locally (uv run cf --help works)
  • No broken markdown links or formatting issues

Summary by CodeRabbit

  • Documentation
    • Added a prominent prerequisite reminder to set ANTHROPIC_API_KEY before running commands.
    • Revamped Quick Start into a concise 5-step flow: install and smoke-test, export API key, initialize a project with detection, generate/list PRD and tasks, then batch-run READY tasks, proof run, and create a PR.
    • Clarified CLI usage: examples assume an active virtual environment; prefix commands with "uv run" when not active.
    • Improved readability and first-time setup guidance.

…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
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7f2f1562-316a-43a8-8853-fa5bda58a7ee

📥 Commits

Reviewing files that changed from the base of the PR and between 62ed81b and 838e50e.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

Walkthrough

README updated to add a prominent ANTHROPIC_API_KEY prerequisite and rework the Quick Start into a 5-step flow: clone/install (with uv run cf --help smoke test), export API key, initialize target project (uv run cf init ... --detect), generate/list/run tasks, run uv run cf proof run, and create a PR. CLI reference note added about uv run when virtualenv is inactive.

Changes

Cohort / File(s) Summary
Documentation & Quickstart Guide
README.md
Added prominent ANTHROPIC_API_KEY prerequisite callout. Replaced single-command quickstart with a 5-step guided workflow: clone/install (+ smoke test), export API key, uv run cf init --detect, generate/list and batch-run tasks, run proofs, and create PR. Clarified CLI reference to note uv run when virtualenv is not active.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README hopped in, tidy and spry,
Five steps to follow, no more asking why.
Export the key, init and run,
Tasks march forward—work gets done!
A tiny carrot-shaped commit—hip-hop, hooray! 🥕✨

🚥 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 changes: a README documentation update with a rewritten quickstart using numbered steps and v0.1.0 release preparation.
Linked Issues check ✅ Passed The PR fully addresses all acceptance criteria from #454: working install path via git clone + uv sync, 5-step quickstart, API key requirement visibility, and v0.1.0 release preparation.
Out of Scope Changes check ✅ Passed All changes are within scope—only README documentation modifications implementing the requirements from #454 without unrelated alterations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/quickstart-and-v0-release

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0ca7ffa2-c54c-43e8-83a5-d093aa87686f

📥 Commits

Reviewing files that changed from the base of the PR and between bb4ffc8 and 62ed81b.

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

@frankbria frankbria merged commit a22d167 into main Mar 20, 2026
8 checks passed
@frankbria frankbria deleted the docs/quickstart-and-v0-release branch March 20, 2026 21:18
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.

Missing quickstart / getting-started experience for new users

1 participant