Skip to content

docs: refresh version pins and test counts to v2.2.0 (Batch 2)#58

Merged
clintecker merged 1 commit into
mainfrom
docs/audit-batch2-versions
Jul 21, 2026
Merged

docs: refresh version pins and test counts to v2.2.0 (Batch 2)#58
clintecker merged 1 commit into
mainfrom
docs/audit-batch2-versions

Conversation

@clintecker

@clintecker clintecker commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Batch 2 of the doc-accuracy audit. Closes #53.

  • F6 — GettingStarted SPM pin from: "1.0.0""2.2.0" (1.0.0 resolves <2.0.0, missing the 2.x format-aware APIs); BRIEF.md v0.8.0 → v2.2.0 across the release line, install pin, and image URLs, snapshot date → 2026-07-21, and dropped the stale v0.8.0/v0.11.0 caveat.
  • F7 — real counts: 407 package tests (was 374) / 386 Linux (was 356) / 353 layout + 42 render + 12 MermaidKitC (was "341 layout, 33 render", third target omitted). Verified via swift test + the Linux CI job.

Left intact: product.md's "G12 shipped in v1.4.0" — correct history (CHANGELOG 1.4.0). Docs-only.

🤖 Generated with Claude Code


View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

Batch 2 of the documentation-accuracy audit (#53).

- F6 version pins:
  - GettingStarted.docc SPM snippet from: "1.0.0" -> "2.2.0" (from: "1.0.0"
    resolves < 2.0.0 and never reaches the 2.x format-aware APIs).
  - website BRIEF.md — "Latest release", the from: pin, the raw.githubusercontent
    image URLs, and the "verified against" snapshot all v0.8.0 -> v2.2.0 (date ->
    2026-07-21); dropped the now-stale "reflects the v0.8.0 snapshot / Linux real
    as of v0.11.0" caveat (Batch 1 already states multi-platform rendering as real).
  - (product.md Status was bumped to v2.2.0 in Batch 1.)
- F7 test counts: 374 -> 407 package tests on macOS (3 skipped); 356 -> 386 on
  Linux (1 skipped); "341 layout, 33 render" -> "353 layout, 42 render, 12
  MermaidKitC" — the previously-omitted third test target now counted.

Left as correct history: product.md's "G12 shipped in v1.4.0" (CHANGELOG 1.4.0).

Closes #53.

Co-Authored-By: Claude Opus 4.8 <[email protected]>
Claude-Session: https://claude.ai/code/session_014CJYAapHgDn2PWGNABnFtv
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 49 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 84cd1705-0791-4cbc-ac12-78dead0e9597

📥 Commits

Reviewing files that changed from the base of the PR and between c61d685 and b7aaaa8.

📒 Files selected for processing (3)
  • Sources/MermaidRender/MermaidRender.docc/GettingStarted.md
  • docs/product.md
  • docs/website/BRIEF.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/audit-batch2-versions

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b7aaaa8756

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/website/BRIEF.md

You are designing a brochure site (GitHub Pages) for MermaidKit. Everything
in this pack was verified against the code at v0.8.0 on 2026-07-08. Cite
in this pack was verified against the code at v2.2.0 on 2026-07-21. Cite

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Update stale coverage before marking v2.2 verified

When the brochure is generated from this now-v2.2-verified pack, it will still publish old limitations: the flowchart section says there are only six node shapes and the known-gaps list still includes flowchart subgraph boxes, while the v2.2 README/product data in this repo documents nested subgraph boxes plus the hexagon and subroutine shapes. Because the brief explicitly tells designers to cite facts as written, this makes the site tell users that supported v2.2 features are missing.

Useful? React with 👍 / 👎.

Comment thread docs/website/BRIEF.md
theming directives (theming is `DiagramTheme`'s job).

## Numbers the site may cite (all verified 2026-07-08)
## Numbers the site may cite (all verified 2026-07-21)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Refresh the verified CI test count

When this numbers section is treated as verified on 2026-07-21, downstream copy will still cite 149 tests in CI, but this same commit updates the product data to 407 macOS package tests and 386 Linux tests, and swift test list in this checkout reports 365 discoverable default-Linux tests before the LinuxRaster-only render tests. Leaving the old count under the newly dated heading contradicts the v2.2 release facts the brief is meant to provide.

Useful? React with 👍 / 👎.

@clintecker
clintecker merged commit 200932b into main Jul 21, 2026
15 checks passed
@clintecker
clintecker deleted the docs/audit-batch2-versions branch July 21, 2026 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs audit · Batch 2: refresh release-version pins and test-suite counts to v2.2.0

1 participant