Skip to content

Move PRD to docs/historical and scrub stale examples#48

Merged
baanish merged 1 commit into
masterfrom
cursor/clean-prd-historical-18e3
Jul 1, 2026
Merged

Move PRD to docs/historical and scrub stale examples#48
baanish merged 1 commit into
masterfrom
cursor/clean-prd-historical-18e3

Conversation

@baanish

@baanish baanish commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Summary

Removes the stale root-level PRD.md from the public-facing repo surface and relocates it to docs/historical/PRD.md with a clear "historical design doc" header pointing readers to README.md for shipped behavior.

Changes

  • Moved PRD.mddocs/historical/PRD.md
  • Replaced personal/stale examples:
    • /Users/aanish/..., /Volumes/Delos/..., orion-app → generic ~/projects/demo-app paths
    • ~/.config/qr/projects/*.toml<project>/.qr/profile.json (JSON)
    • qr run watch <script>qr run --watch <script> (and siblings)
    • ~/.config/qr/config.toml / stats.db~/.qr/ layout
  • Updated project structure, config defaults, and shipped-scope table to match current code/README
  • Aligned .qr.toml override example with the actual flat-field + [scripts] format

Why

This was the last public-readiness nit called out before making the repo loud. README/config/code were already current; the PRD was the outlier with personal paths and pre-breaking-change syntax.

Testing

Docs-only change — no code or test updates required.

Open in Web Open in Cursor 

Summary by CodeRabbit

  • Documentation
    • Updated the historical product guide to better distinguish internal notes from shipped behavior.
    • Refreshed command examples, shortcuts, and flag usage for clearer setup and usage guidance.
    • Revised AI workflow examples, stats output, and configuration samples to match the latest naming and storage locations.
    • Expanded the learning workflow example and updated config migration, environment overrides, and shell integration notes.

Relocate the product requirements doc out of the repo root so it does not
compete with README as the public source of truth. Add a historical header,
replace personal paths and project names with generic examples, update config
locations to ~/.qr/, fix qr run to flag syntax (--watch/--log/--output), and
align qr learn storage with ./.qr/profile.json.

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: 817eee21-392b-472b-975b-746d38b45e64

📥 Commits

Reviewing files that changed from the base of the PR and between cd6ff3c and f912eb7.

📒 Files selected for processing (1)
  • docs/historical/PRD.md

📝 Walkthrough

Walkthrough

This PR updates the historical PRD document to clarify its internal/reference status, rewrites command documentation (shortcuts, qr go, qr run flags), refreshes provider naming to "openai", changes stats/config storage paths, rewrites the qr learn section, and updates the shipped-scope feature matrix.

Changes

PRD Documentation Update

Layer / File(s) Summary
Header and AI backend framing
docs/historical/PRD.md
Header marks the document as historical/internal pointing to README.md; AI backend table clarifies supported protocol families.
Command reference updates
docs/historical/PRD.md
Adds new single-letter shortcuts for qr do/qr learn, updates qr go sample project and roots, rewrites qr run to flag-based mutually-exclusive syntax, and updates picker example.
Stats and AI integration wording
docs/historical/PRD.md
Refreshes provider naming to "openai" in stats examples and aggregate output, updates local stats storage path, revises AI protocol bullets, qr do intro, and approval flow output.
qr learn rewrite
docs/historical/PRD.md
Rewrites the qr learn walkthrough using a demo-app example and project-local .qr/profile.json storage semantics.
Config examples and project structure
docs/historical/PRD.md
Updates the .qr.toml override example, project structure tree, ~/.qr/config.toml location/migration docs, env-var overrides table, and shell integration note.
Shipped scope rewrite
docs/historical/PRD.md
Replaces the v1 scope framing with a v2-oriented feature matrix and updated success metrics.

Estimated code review effort: 2 (Simple) | ~10 minutes


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.

@baanish baanish marked this pull request as ready for review July 1, 2026 16:19
@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 (1 file)
  • docs/historical/PRD.md

Reviewed by glm-5.2-short · Input: 22.2K · Output: 2.1K · Cached: 85.9K

@baanish baanish merged commit ef4b864 into master Jul 1, 2026
6 checks passed
baanish added a commit that referenced this pull request Jul 2, 2026
Relocate the product requirements doc out of the repo root so it does not
compete with README as the public source of truth. Add a historical header,
replace personal paths and project names with generic examples, update config
locations to ~/.qr/, fix qr run to flag syntax (--watch/--log/--output), and
align qr learn storage with ./.qr/profile.json.

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Aanish Bhirud <baanish@users.noreply.github.com>
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