Move PRD to docs/historical and scrub stale examples#48
Conversation
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>
ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Free Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis 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. ChangesPRD Documentation Update
Estimated code review effort: 2 (Simple) | ~10 minutes Note 🎁 Summarized by CodeRabbit FreeYour 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 |
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (1 file)
Reviewed by glm-5.2-short · Input: 22.2K · Output: 2.1K · Cached: 85.9K |
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>
Summary
Removes the stale root-level
PRD.mdfrom the public-facing repo surface and relocates it todocs/historical/PRD.mdwith a clear "historical design doc" header pointing readers toREADME.mdfor shipped behavior.Changes
PRD.md→docs/historical/PRD.md/Users/aanish/...,/Volumes/Delos/...,orion-app→ generic~/projects/demo-apppaths~/.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.qr.tomloverride example with the actual flat-field +[scripts]formatWhy
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.
Summary by CodeRabbit