docs: fix build recipes, packaging, and source-path references (Batch 3)#59
Conversation
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
Batch 3 of the documentation-accuracy audit (#54). - F8: note the Linux/Silica render backend is behind the `LinuxRaster` package trait (off by default) in MermaidRender.docc and the Silica port memo — the no-trait graph is Silica-free on every platform. - F10: android/README build recipe used a nonexistent `swift-android-6.2` Docker image; replace with the real recipe (base `swift:6.2.0` + `swift sdk install` of the finagolfin Swift Android SDK bundle), matching CI and scripts/check-android-build.sh. - F11: CONTRIBUTING told contributors to run `swift test --package-path MermaidKit`; there is no such subpackage (Package.swift is the repo root) — dropped it. - F12: mermaid-coverage-audit banner claimed the big-five parsers (flowchart/sequence/class/state/er) were split into per-type files; they still live in the monolithic `MermaidParser.swift` (only newer types have +<Type> files). - F18: android.md Phase 1 listed arm64-v8a/armeabi-v7a as "still open"; the release-AAR CI job builds and bundles all three ABIs (asserts each .so present). - F21: android.md over-credited check-android-build.sh (arm64-only buildability check, no symbol verification) with x86_64 + unmangled-symbol checks; attribute arm64 to that script and x86_64 to the emulator job, drop the symbol-export claim. Closes #54. Co-Authored-By: Claude Opus 4.8 <[email protected]> Claude-Session: https://claude.ai/code/session_014CJYAapHgDn2PWGNABnFtv
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 43 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2af52db198
ℹ️ 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".
| 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) |
There was a problem hiding this comment.
With this heading changed to say the numbers were verified on 2026-07-21 for v2.2.0, the unchanged bullet below now tells site authors to cite “149 tests in CI” for the current release. That is stale: this same patch's docs/product.md reports 407 package tests on macOS (353 layout + 42 render + 12 C) / 386 on Linux, and swift test list in this tree discovers 365 no-trait Linux tests before render-trait tests. Because the brief instructs the website to cite these numbers verbatim, the site would publish an outdated QA claim unless that test-count bullet is updated too.
Useful? React with 👍 / 👎.
1 participant
Batch 3 of the doc-accuracy audit. Closes #54. Each verified against code/CI:
LinuxRastertrait (off by default); noted in MermaidRender.docc + the port memo.swift-android-6.2Docker image doesn't exist; real recipe isswift:6.2.0+swift sdk install(finagolfin Swift Android SDK), per ci.yml / check-android-build.sh.--package-path MermaidKitpoints at a subpackage that doesn't exist (Package.swift is the root).MermaidParser.swift(verified: no+Flowchart/+Sequence/+Class/...files); banner corrected.Docs-only.
🤖 Generated with Claude Code
Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.