Repository navigation
docs: make the product overview developer-centric - #222
Conversation
Lead every overview with the developer: their repository, their terminal, their choice of model and agent, their keys in their keychain. QualityMax stays an optional, first-class MCP integration but no longer frames the opening copy. README: replace the "Where it sits" / "What qmax-code can do" sections with "Built for developers" (local by default, your keys, one binary, nothing hidden, QA in the dev loop, QualityMax when you want it), "Where it is going", and a capability table that states exactly what works in --local versus connected mode. The standalone boundary is taken from internal/agent/tools.go: five local tools plus /orch backends and /skills; everything else needs a QualityMax connection. AGENTS.md and CLAUDE.md: same positioning for agents, with an explicit instruction not to imply connected tools work offline. doc.go: package comment rewritten to match. Documentation only; go build, go vet, go test ./... and git diff --check pass.
QualityMax ReviewVerdict: COMMENT · Confidence: evidence-backed scan Re-review: Open the QualityMax check and select Re-review after it completes. Files eligible: 4 · Files reviewed: 4 · Files with findings: 0 · Findings: 0 · Inline cards: 0 Priority findings
Review gates
Important files
Review lifecycleUse the inline cards to inspect evidence and suggested remediation. Re-run the QualityMax review after pushing a fix; unchanged cards are identified by their stable finding marker. Dismiss with a reason through the existing QualityMax/GitHub review feedback flow. 0 prior card(s) are stale/resolved on this head. Proof legend: GROUNDED deterministic scanner evidence · MODEL-ONLY advisory model judgment · MODEL-REVIEWED patch model judgment, not reproduction. QualityMax project results are available in the configured project. Receipt · commit |
QualityMax Code HealthGrade A · 100/100 · PASS — 0 finding(s) in 4 file(s). No code-health findings. Full report · Commit 23d0335 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
| Gate | Result |
|---|---|
| 🔍 AI diff review | ✅ Clean · gemini-3.1-flash-lite · completed · 1 eligible / 1 reviewed · gemini-3.1-flash-lite |
| 🔍 SAST | completed · 4 eligible / 4 reviewed |
| 🔍 Canonical PR review delivery | completed · 0 eligible / 0 reviewed · exact-head review #5783487510 and overview #6655767916 confirmed |
| 🧪 Repo Tests | ✅ 1551/1551 passed (go) |
| 🤖 AI Tests | ❌ 51/56 passed (go_test) — 1 issue(s) |
Powered by QualityMax — AI-Powered Test Automation
What
Rewrites the product overview so it leads with the developer: their repository, their terminal, their choice of model and agent, their keys in their keychain. QualityMax stays an optional, first-class MCP integration but no longer frames the opening copy.
Why
The README opened with the IDE direction and the QualityMax relationship before saying what a developer gets on their own machine. This change makes the standalone experience the headline and states the connected boundary exactly, so nobody reads a connected-only feature as something that works offline.
Changes
--localtool boundary and an instruction not to imply connected tools work offline.The standalone boundary in the table comes from
internal/agent/tools.go(localOnlyToolNames): five local tools plus/orchbackends and/skills. Every other tool is refused until connected.How to review
README.mdfrom the tagline through "What qmax-code can do" as a newcomer would.localOnlyToolNamesininternal/agent/tools.go.AGENTS.md"Positioning" and theCLAUDE.mdintro for consistency with the README.Documentation only.
go build,go vet ./...,go test ./..., andgit diff --checkpass locally.