Skip to content

docs: fix the version story and add orchestration, lifecycle, and family diagrams - #161

Merged
Desperado merged 1 commit into
mainfrom
agent/readme-refresh
Aug 4, 2026
Merged

docs: fix the version story and add orchestration, lifecycle, and family diagrams#161
Desperado merged 1 commit into
mainfrom
agent/readme-refresh

Conversation

@Desperado

Copy link
Copy Markdown
Contributor

A documentation and visual pass. No code changes — go build and go 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 --local standalone 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.md carried 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.

Diagram Where Why
orchestration.svg Orchestration mode Replaces the ASCII flow. Makes the point the prose works hardest to convey: /orch picks a backend, but mode decides which tools exist.
lifecycle.svg What qmax-code can do Gives the bullet wall a shape, and shows which lane survives in standalone mode.
family.svg Intro Places qmax-code among free-qa-skills, qmax-mcp, 9lives, and qmax-local-agent. That positioning existed nowhere public.

The 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

  • Release badge, and the Go badge pinned to 1.24+ to match the build requirement already stated under Install.

…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

sigilix Bot commented Aug 4, 2026

Copy link
Copy Markdown

Sigilix Overview

Effort: 2/5 (small)

Quality gates

  • ✅ PR title follows convention
  • ✅ PR description is complete
  • ℹ️ PR is linked to an issue — No Closes #N / Closes SIG-N keyword found in PR body or commit messages.

Summary — latest push

Corrects 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

File Score Notes Next step
README.md 3/5 Rewrites the version story to split v1.21 and v1.22 items correctly, adds the v1.22.1 MCP routing fix, embeds three new diagrams, pins the Go badge to 1.24+, and adds a release badge. Verify the v1.22.1 MCP routing description matches the CHANGELOG entry exactly to avoid a second stale version claim.
docs/img/orchestration.svg 2/5 New SVG replacing the ASCII flow, showing how /orch picks a backend while mode decides which tools exist. Confirm the SVG renders correctly at narrow viewport widths and that the <title>/ accessibility text is read by a screen reader.
docs/img/family.svg 2/5 New SVG positioning qmax-code among the five open QualityMax tools with account-required callouts. Check that the linked repository names (free-qa-skills, qmax-mcp, 9lives, qmax-local-agent) match the actual GitHub org slugs.
docs/img/lifecycle.svg 2/5 New SVG showing the plan→generate→execute→review→ship stages over a local repository lane. Verify the standalone --local lane description matches the actual behavior when QMAX_EXPERIMENTAL is unset.
docs/COMMANDS.md 1/5 Bumps the version reference in the header from v1.21 to v1.22. Confirm the v1.22 reference aligns with the current release version shown on the new release badge.

Confidence: 5/5

Documentation-only change with no code surface, corrects factual inaccuracies, and the specialist review returned zero findings.

  • README lines 77-87: confirm the v1.22.1 MCP routing description (trace context, session history, UI-shaped payloads) is accurate against the actual CHANGELOG entry.
  • README line 18: verify the release badge URL resolves and the Go 1.24+ badge text matches the minimum version in go.mod.
  • All three SVGs: confirm <title> and elements are present and meaningful for screen readers (they are present in the diff, but worth a visual spot-check).
  • README line 214: the ASCII orchestration flow was removed — confirm the equivalent tree in docs/ORCHESTRATION.md still covers the same information for plain-text readers.

Suggested labels: docs


Posted · 1e3fd3c · 0 findings — View review
Dismiss @sigilix dismiss <reason> (not-a-bug | bad-anchor | already-covered | too-minor | wrong-context) · Re-run /sigilix review
Sigilix · 0 of 50 reviews used in past 5h

@sigilix sigilix Bot added the documentation Improvements or additions to documentation label Aug 4, 2026

@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; inline findings are attached to this review.

@qualitymaxapp

qualitymaxapp Bot commented Aug 4, 2026

Copy link
Copy Markdown

QualityMax Review

Verdict: COMMENT · Confidence: unavailable — no completed model review

Files eligible: 5 · Files reviewed: 5 · Files with findings: 0 · Findings: 0 · Inline cards: 0

Priority findings

priority location finding
No blocking findings

Review gates

gate status
AI diff review skipped · eligible 0, reviewed 0 · LLM · All changed files were excluded as non-code, generated, or binary content.
SAST completed · eligible 5, reviewed 5 · hybrid
Overall review evidence unavailable — insufficient model review evidence
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: 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 1e3fd3c3f51d0c3f38718c8479005d4dd3580749 · run 2026-08-04T12:17:41+00:00 · model served not applicable · model requested not applicable · model review unavailable — no completed model review · model source not recorded · re-review 1 · proof counts {}

@qualitymaxapp

qualitymaxapp Bot commented Aug 4, 2026

Copy link
Copy Markdown

⚠️ QualityMax Pipeline

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 ⚠️ 51/56 passed

Powered by QualityMax — AI-Powered Test Automation

@Desperado
Desperado merged commit 5858f81 into main Aug 4, 2026
6 of 7 checks passed
@Desperado
Desperado deleted the agent/readme-refresh branch August 4, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation qualitymax:reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant