Skip to content

Clean up public docs drift for release#42

Closed
baanish wants to merge 1 commit into
masterfrom
cursor/public-docs-cleanup-93e4
Closed

Clean up public docs drift for release#42
baanish wants to merge 1 commit into
masterfrom
cursor/public-docs-cleanup-93e4

Conversation

@baanish

@baanish baanish commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Summary

Aligns README and release docs with current shipped behavior before going public.

  • Fixes qr run syntax to flag form: qr run [--watch|--log|--output] <script>
  • Narrows QR_* override claim (no [do.agents] env overrides)
  • Documents qr do single default-No confirmation (no shell-feature warnings)
  • Archives docs/PRE_RELEASE_REVIEW.md — fixed blockers marked historical

Test plan

  • rg drift check (only intentional historical allowlist mention in CHANGELOG)
  • cargo test
Open in Web Open in Cursor 

Summary by CodeRabbit

  • Documentation
    • Clarified the README’s configuration, AI key, and command usage guidance.
    • Updated qr do behavior notes to show the command preview and confirmation prompt.
    • Added a clearer note that qr learn runs locally without a live model call.
    • Replaced the pre-release review document with a shorter archival reference focused on current release sources and past resolved issues.

Co-authored-by: Aanish Bhirud <baanish@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: 3d3e002e-7a8e-45f2-a238-cd66cc16cfb4

📥 Commits

Reviewing files that changed from the base of the PR and between fcf57af and bfd5934.

📒 Files selected for processing (2)
  • README.md
  • docs/PRE_RELEASE_REVIEW.md

📝 Walkthrough

Walkthrough

README.md wording was updated to remove the "every config key overridable" claim, revise flag syntax, clarify AI key/qr do/qr learn behavior, and describe the qr do run confirmation prompt. docs/PRE_RELEASE_REVIEW.md was replaced with a shorter archival note summarizing resolved historical findings.

Changes

Documentation Updates

Layer / File(s) Summary
README config and AI key clarifications
README.md
Removes the "every config key" env-override claim, updates qr run flag syntax to --watch|--log|--output, rewrites config defaults text to reference config/default.toml, clarifies qr do API key requirement, and notes qr learn is local.
README qr do execution notes
README.md
Updates Notes section to describe the full command preview and Run this command? [y/N] confirmation prompt, removing prior shell-feature warning language.
Pre-release review archival rewrite
docs/PRE_RELEASE_REVIEW.md
Replaces the detailed hardening plan with an archival disclaimer, a sources-of-truth section, a condensed list of already-fixed findings, and a short pointer to git history/changelog for details.

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

Related PRs: None identified.

Suggested labels: documentation

Suggested reviewers: None identified.

🐰 Poem

A rabbit reads the README twice,
No more "every key" — that claim was nice but not precise.
The old review plan, long and grand,
Now fits in a paragraph, docs held in hand.
Hop along, the docs are trimmed just right! 🥕


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

@cursor cursor Bot marked this pull request as ready for review July 1, 2026 09:40
@kilo-code-bot

kilo-code-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (2 files)
  • README.md
  • docs/PRE_RELEASE_REVIEW.md

Reviewed by glm-5.2-short · Input: 35K · Output: 2.9K · Cached: 359.4K

@baanish baanish closed this Jul 1, 2026
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.

2 participants