Skip to content

docs: tidy diagram labels, linter table, and remaining nits (Batch 5)#61

Merged
clintecker merged 1 commit into
mainfrom
docs/audit-batch5-nits
Jul 21, 2026
Merged

docs: tidy diagram labels, linter table, and remaining nits (Batch 5)#61
clintecker merged 1 commit into
mainfrom
docs/audit-batch5-nits

Conversation

@clintecker

@clintecker clintecker commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Batch 5 (final) of the doc-accuracy audit. Closes #56. Each verified against code:

  • F15 — added the 3 linter checks the table omitted (edge-endpoint-detached, edges-doubled, edge-under-label), from DiagramScene.swift.
  • F19 — real Kotlin signature is draw(scene, canvas) (SceneRenderer.kt:36).
  • F22 — swimlane also uses the network-simplex layered layout; maxEdges is a shared parse cap, not flowchart-specific.
  • F23 — most-portable terminal tier is monochrome Unicode box-drawing, not "plain ASCII".
  • F24 — venn is shipped, not a hypothetical venn-beta.
  • F26/F27 — pi-canvas "No core changes" (it added a Linux rgbaRaster) and the unverified "60fps on a Pi 5" figure.

Completes the audit (tracking #51). 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 5)

Batch 5 (final) of the documentation-accuracy audit (#56).

- F15: SceneGeometryAndLinting linter table omitted three checks the linter emits
  — added edge-endpoint-detached (error), edges-doubled (error), edge-under-label
  (warning), from DiagramScene.swift.
- F19: android/README pipeline diagram showed SceneRenderer.draw(canvas); the real
  Kotlin signature is draw(scene, canvas).
- F22: performance.md called flowchart the *only* super-linear layout and maxEdges
  flowchart-specific; swimlane shares the same network-simplex layered layout, and
  maxEdges is a shared parse-level cap.
- F23: README terminal ladder called the most-portable tier "plain ASCII"; it is
  monochrome Unicode box-drawing.
- F24: AddingADiagramType framed venn as a hypothetical "venn-beta"; venn is a real
  shipped type — reframed as a worked example with finished files to read.
- F26: pi-canvas "No core changes" contradicted its own "gap it closed" (a Linux
  rgbaRaster was added to core) — reworded.
- F27: dropped the unverified "60fps on a Pi 5" panning figure.

Closes #56. Completes the documentation-accuracy audit (tracking #51).

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: 13 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: 280fb74e-ea87-4cc8-aab8-35fcfeae1845

📥 Commits

Reviewing files that changed from the base of the PR and between 9b73f14 and e31530f.

📒 Files selected for processing (6)
  • README.md
  • Sources/MermaidLayout/MermaidLayout.docc/AddingADiagramType.md
  • Sources/MermaidLayout/MermaidLayout.docc/SceneGeometryAndLinting.md
  • android/README.md
  • docs/notes/performance.md
  • tools/pi-canvas/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/audit-batch5-nits

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: e31530f2af

ℹ️ 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/notes/performance.md
Comment on lines +138 to +139
is **super-linear in edge count**, which is why the parse-level `maxEdges` (500)
cap bounds it.

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 Don't claim maxEdges bounds swimlane layouts

When this sentence includes swimlane in the shared layered-layout path, it reads as though the parse-level MermaidParser.maxEdges cap bounds both flowchart and swimlane. However parseSwimlane builds and returns the diagram without an edges.count guard, while only the flowchart dispatch wraps its parser with edges.count <= maxEdges. A large swimlane source under maxTextSize can still feed more than 500 edges into the super-linear layout, so this understates the remaining performance/input-bound risk.

Useful? React with 👍 / 👎.

@clintecker
clintecker merged commit 21172d9 into main Jul 21, 2026
15 checks passed
@clintecker
clintecker deleted the docs/audit-batch5-nits branch July 21, 2026 19:21
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 5: tidy diagram labels, linter-table, and remaining accuracy nits

1 participant