Skip to content

docs: make the product overview developer-centric - #222

Merged
Desperado merged 1 commit into
mainfrom
feat/developer-centric-overview
Nov 5, 2026
Merged

Desperado merged 1 commit into
mainfrom
feat/developer-centric-overview

Conversation

@Desperado

Copy link
Copy Markdown
Contributor

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

  • README: new tagline; "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"; a capability table with a Standalone vs Connected column. The job-picker table now starts with local repo work.
  • AGENTS.md / CLAUDE.md: same positioning for agents, plus the precise --local tool boundary and an instruction not to imply connected tools work offline.
  • doc.go: package comment matches.

The standalone boundary in the table comes from internal/agent/tools.go (localOnlyToolNames): five local tools plus /orch backends and /skills. Every other tool is refused until connected.

How to review

  1. Read README.md from the tagline through "What qmax-code can do" as a newcomer would.
  2. Check the capability table against localOnlyToolNames in internal/agent/tools.go.
  3. Skim AGENTS.md "Positioning" and the CLAUDE.md intro for consistency with the README.

Documentation only. go build, go vet ./..., go test ./..., and git diff --check pass locally.

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.
@qualitymaxapp

qualitymaxapp Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

QualityMax Review

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

priority location finding
— — No blocking findings

Review gates

gate status
AI diff review completed · eligible 1, reviewed 1 · MODEL-ONLY findings are advisory · batches reviewed 1 of 1 · LLM · served gemini-3.1-flash-lite
SAST completed · eligible 4, reviewed 4 · hybrid
Overall review evidence clean
Inline evidence not needed

Important files

file risk note next step
— — No findings —

Review lifecycle

Use 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. @qmax Q&A is tracked separately.

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 23d03352a705c680bb39256ebdedee66e066f9f9 · run 2026-11-05T10:33:55+00:00 · model served gemini-3.1-flash-lite · model requested gemini-3.1-flash-lite · model review recorded — 180 model output tokens · model source repository ai_review_preferences.preferred_model · re-review 2 · proof counts {}

@qualitymaxapp qualitymaxapp Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QualityMax Review — canonical overview updated; no inline findings were created for this review.

@qualitymaxapp

qualitymaxapp Bot commented Nov 5, 2026

Copy link
Copy Markdown

QualityMax Code Health

Grade A · 100/100 · PASS — 0 finding(s) in 4 file(s).

No code-health findings.

Full report · Commit 23d0335

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@qualitymaxapp

qualitymaxapp Bot commented Nov 5, 2026

Copy link
Copy Markdown

⚠️ QualityMax Pipeline

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

@Desperado
Desperado merged commit 87f6121 into main Nov 5, 2026
5 of 6 checks passed
@Desperado
Desperado deleted the feat/developer-centric-overview branch November 5, 2026 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants