Skip to content

Commit b7aaaa8

Browse files
clinteckerclaude
andcommitted
docs: refresh version pins and test counts to v2.2.0 (Batch 2)
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 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014CJYAapHgDn2PWGNABnFtv
1 parent c61d685 commit b7aaaa8

3 files changed

Lines changed: 12 additions & 14 deletions

File tree

Sources/MermaidRender/MermaidRender.docc/GettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ app's shape.
66
## Add the package
77

88
```swift
9-
.package(url: "https://github.com/2389-research/MermaidKit.git", from: "1.0.0")
9+
.package(url: "https://github.com/2389-research/MermaidKit.git", from: "2.2.0")
1010
```
1111

1212
Depend on the `MermaidRender` product (it brings `MermaidLayout` with it).

docs/product.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Feature groups are labeled **G1–G12** and referenced by shorthand throughout.
2222
| Rendering | Native geometry pipeline: parse → layout → common scene IR → draw. The layout core and scene IR are platform-free; each platform supplies only the draw surface (CoreGraphics, Silica/Cairo, Android/Skia `Canvas`, SkiaSharp, Flutter `Canvas`, or SVG/Canvas2D). No web view, no headless browser, no Mermaid.js. |
2323
| Dependencies | Zero third-party packages on Apple. On Linux the render backend adds Silica (Cairo/FontConfig); `MermaidLayout` depends on nothing. |
2424
| Coverage | **30 distinct diagram types** (`MermaidDiagram` enum, 30-branch parser dispatch, 30-row README matrix, 30 fixtures). |
25-
| Verification | 374 package tests on macOS, 0 failures (3 intentionally env-gated skips). On Linux, 356 tests run in a `swift:6.2` container (1 skipped) — the `MermaidLayout` suite plus Silica render smoke tests (all 30 fixtures render). |
25+
| Verification | 407 package tests on macOS, 0 failures (3 intentionally env-gated skips). On Linux, 386 tests run in a `swift:6.2` container (1 skipped) — the `MermaidLayout` suite plus Silica render smoke tests (all 30 fixtures render). |
2626
| Origin | Built so that a diagram's source of truth stays the Mermaid text — parsed, laid out, and drawn natively in a Swift app — with layout judged by machine-checkable geometry rather than pixels, and with no runtime dependency on a JavaScript engine or web view. Consumed by the Quoin markdown editor as a first-party engine. |
2727

2828
---
@@ -165,8 +165,8 @@ Named properties with dedicated tests, run on every CI build.
165165

166166
| Feature | Specific |
167167
| :--- | :--- |
168-
| Test suite | 374 package tests, 0 failures (3 intentionally env-gated skips: doc-image generation, single-type lint, and the cross-process determinism-signature dump). 341 layout tests, 33 render tests. |
169-
| Cross-platform | 356 tests green on Linux (`swift:6.2` container, `--traits LinuxRaster`, 1 skipped): the `MermaidLayout` suite plus the Silica render smoke tests (all 30 fixtures render). `MermaidLayout` still builds on bare swift-corelibs-foundation with the default (Silica-free) graph, so the platform-free contract stays compiler-enforced. |
168+
| Test suite | 407 package tests, 0 failures (3 intentionally env-gated skips: doc-image generation, single-type lint, and the cross-process determinism-signature dump). 353 layout tests, 42 render tests, 12 MermaidKitC tests. |
169+
| Cross-platform | 386 tests green on Linux (`swift:6.2` container, `--traits LinuxRaster`, 1 skipped): the `MermaidLayout` suite plus the Silica render smoke tests (all 30 fixtures render). `MermaidLayout` still builds on bare swift-corelibs-foundation with the default (Silica-free) graph, so the platform-free contract stays compiler-enforced. |
170170
| Dependency policy | The Silica/Cairo Linux render backend is behind the `LinuxRaster` package trait (default OFF). A `from:`-pinned consumer resolves a Silica-free graph on every platform — no unstable branch dependency, no Cairo/PureSwift stack fetched on Apple. Linux users opt in with `traits: ["LinuxRaster"]`. |
171171
| CI | `test` (macOS): `swift build` + `swift test` on Xcode 26, plus a compile-only iOS-Simulator guard (a UIKit branch with no test host that must always compile). `linux`: installs Cairo/FontConfig, then `swift build --traits LinuxRaster` + `swift test --traits LinuxRaster`, and a `swift build --target MermaidLayout` proving the default Silica-free graph builds. |
172172
| Parser honesty | `ParserHonestyTests` (41 tests) pins that syntax once silently dropped or mangled now parses faithfully; `AdversarialInputTests` (11) that hostile input never crashes. |

docs/website/BRIEF.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# MermaidKit — design context pack
22

33
You are designing a brochure site (GitHub Pages) for MermaidKit. Everything
4-
in this pack was verified against the code at v0.8.0 on 2026-07-08. Cite
4+
in this pack was verified against the code at v2.2.0 on 2026-07-21. Cite
55
facts as written; do not embellish, round up, or invent. Where a claim
66
feels thin, use fewer claims — the diagrams do the impressing.
77

@@ -14,7 +14,7 @@ view, image / attributed-string / vector-PDF output, VoiceOver
1414
descriptions for every diagram, themed with a single value. MIT license.
1515

1616
- Repo: https://github.com/2389-research/MermaidKit
17-
- Latest release: v0.8.0
17+
- Latest release: v2.2.0
1818
- Site target: https://2389-research.github.io/MermaidKit/ — a static
1919
`index.html` placed in the repo's `docs/` folder (GitHub Pages serves
2020
`docs/` from `main`; reference images relatively as `images/...`)
@@ -88,7 +88,7 @@ surface (all verified names):
8888

8989
Install:
9090
```swift
91-
.package(url: "https://github.com/2389-research/MermaidKit.git", from: "0.8.0")
91+
.package(url: "https://github.com/2389-research/MermaidKit.git", from: "2.2.0")
9292
```
9393

9494
### 3. Built to meet people where they are
@@ -157,7 +157,7 @@ subgraph boxes and `@{ shape }` shape library; HTML in labels beyond
157157
`<br/>`; FontAwesome icons; click/animation interactivity; mermaid.js
158158
theming directives (theming is `DiagramTheme`'s job).
159159

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

162162
- **30** diagram types. **Zero** dependencies. Zero JavaScript, no
163163
WebView.
@@ -184,11 +184,11 @@ Each exists in light and dark; serve both via `<picture>` with
184184
dark variants).
185185

186186
**Hero** — MermaidKit's own render pipeline as a sankey (~2200px wide):
187-
- https://raw.githubusercontent.com/2389-research/MermaidKit/v0.8.0/docs/images/hero-light.png
188-
- https://raw.githubusercontent.com/2389-research/MermaidKit/v0.8.0/docs/images/hero-dark.png
187+
- https://raw.githubusercontent.com/2389-research/MermaidKit/v2.2.0/docs/images/hero-light.png
188+
- https://raw.githubusercontent.com/2389-research/MermaidKit/v2.2.0/docs/images/hero-dark.png
189189

190190
**Per-type gallery** (30 × 2, max 2000px wide). Pattern:
191-
`https://raw.githubusercontent.com/2389-research/MermaidKit/v0.8.0/docs/images/types/<name>.png`
191+
`https://raw.githubusercontent.com/2389-research/MermaidKit/v2.2.0/docs/images/types/<name>.png`
192192

193193
| name | the self-portrait shows |
194194
|---|---|
@@ -256,7 +256,7 @@ let pdf = MermaidRenderer.pdfData(source: source, theme: theme)
256256

257257
Install:
258258
```swift
259-
.package(url: "https://github.com/2389-research/MermaidKit.git", from: "0.8.0")
259+
.package(url: "https://github.com/2389-research/MermaidKit.git", from: "2.2.0")
260260
```
261261

262262
## Voice (non-negotiable)
@@ -291,5 +291,3 @@ Single page, static HTML/CSS, fast on a phone, light/dark aware. The
291291
diagrams are colorful; keep the chrome quiet around them. **No analytics
292292
or trackers** — the library's privacy story is "no network" and the site
293293
must live up to it. Don't claim full mermaid.js syntax parity.
294-
(Linux rendering *is* real as of v0.11.0 — MermaidRender draws via Silica/Cairo
295-
there; this brief otherwise reflects the v0.8.0 snapshot noted above.)

0 commit comments

Comments
 (0)