docs: fix the version story and add orchestration, lifecycle, and family diagrams - #161
Conversation
…ifecycle, and family The README's headline section was titled "What is new in v1.21" while the latest release is v1.22.1, and it listed `--local` standalone mode among the v1.21 items even though the CHANGELOG puts it in v1.22.0. Split the section by release and attribute each feature correctly. v1.22.1's cloud MCP routing fix was not mentioned anywhere in the README. It is the reason tool calls made through the local MCP server are now visible to the platform at all, so it belongs in the headline list rather than only the changelog. docs/COMMANDS.md carried the same stale v1.21 reference. Add three SVG diagrams, sharing the house style used by the qmax-mcp architecture diagram so the org's repos read as one family: - orchestration.svg replaces the ASCII flow in the README. It makes the point the prose has to work hardest to convey: the picker chooses a backend, but mode — not backend — decides which tools exist. The equivalent ASCII tree already lives in docs/ORCHESTRATION.md, so nothing is lost for plain-text readers. - lifecycle.svg gives the "what qmax-code can do" bullets a shape, and shows which lane survives in standalone mode. - family.svg places qmax-code among free-qa-skills, qmax-mcp, 9lives, and qmax-local-agent. That positioning existed nowhere public. Also add a release badge and pin the Go badge to 1.24+, matching the build requirement already stated under Install.
Sigilix OverviewEffort: 2/5 (small) Quality gates
Summary — latest pushCorrects the README's version history — the v1.21 section was stale and the v1.22.1 cloud MCP routing fix was entirely absent — and replaces the ASCII orchestration flow with three purpose-built SVG diagrams (orchestration, lifecycle, family) that carry accessibility metadata. The Go badge is also pinned to 1.24+ to match the build requirement, and a release badge is added. Important files
Confidence: 5/5Documentation-only change with no code surface, corrects factual inaccuracies, and the specialist review returned zero findings.
Suggested labels:
|
QualityMax ReviewVerdict: COMMENT · Confidence: unavailable — no completed model review Files eligible: 5 · Files reviewed: 5 · 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: VERIFIED independently judged patch · REPRODUCED verified finding · GROUNDED deterministic evidence · MODEL-ONLY model judgment. QualityMax project results are available in the configured project. Receipt · commit |
|
| Gate | Result |
|---|---|
| 🔍 AI diff review | ⏭️ Skipped — All changed files were excluded as non-code, generated, or binary content. · skipped · 0 eligible / 0 reviewed · All changed files were excluded as non-code, generated, or binary content. |
| 🔍 SAST | completed · 5 eligible / 5 reviewed |
| 🔍 Canonical PR review delivery | completed · 0 eligible / 0 reviewed · exact-head review #4854214347 and overview #5178920924 confirmed |
| 🧪 Repo Tests | ✅ 553/553 passed (go) |
| 🤖 AI Tests |
Powered by QualityMax — AI-Powered Test Automation
A documentation and visual pass. No code changes —
go buildandgo vet ./...pass.The version story was wrong
The README's headline section was titled "What is new in v1.21" while the latest release is v1.22.1. It also listed
--localstandalone mode among the v1.21 items, but the CHANGELOG puts that in v1.22.0.More importantly, v1.22.1's cloud MCP routing fix was not mentioned in the README at all. That fix is why tool calls made through the local MCP server are visible to the platform — before it they set no trace context, produced no session history, and returned UI-shaped REST payloads carrying every script's full source. A reader of the README would never have learned it happened.
The section is now split by release with each feature attributed correctly.
docs/COMMANDS.mdcarried the same stale v1.21 reference.Three diagrams
All three share the house style already used by the qmax-mcp architecture diagram, so the org's repos read as one family.
orchestration.svg/orchpicks a backend, but mode decides which tools exist.lifecycle.svgfamily.svgThe ASCII flow removed from the README is not lost — an equivalent tree already lives in
docs/ORCHESTRATION.md, so plain-text readers keep it.Each SVG carries
<title>and<desc>for screen readers, and every diagram was rendered and visually checked rather than committed sight-unseen.Also