Skip to content

Address CodeRabbit feedback on #47/#57 (a11y caption + doc fixes) - #64

Merged
clintecker merged 2 commits into
mainfrom
fix/coderabbit-followups
Aug 12, 2026
Merged

Address CodeRabbit feedback on #47/#57 (a11y caption + doc fixes)#64
clintecker merged 2 commits into
mainfrom
fix/coderabbit-followups

Conversation

@clintecker

@clintecker clintecker commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

CodeRabbit posted actionable comments on #47 and #57 after they merged (it was rate-limited at merge time). All verified still-valid against main and fixed, plus one related audit blind spot I caught while reviewing:

417 tests (+1). One small a11y fix + docs; no rendering behavior change.

🤖 Generated with Claude Code

Post-merge review comments (both PRs merged while CodeRabbit was rate-limited),
verified still-valid against main:

- a11y (#47): DiagramRenderer.attachmentString(diagram:title:) rendered the title
  caption visually but narrated only the diagram — assistive-tech users lost the
  caption. Fold a non-empty title into the altText. New test testCaptionIsNarrated
  asserts the caption leads the narration (and no stray prefix when title is nil).
- README (#47): document the format-aware pngData(source:format:theme:) overload
  in both API lists (it shipped in #47 but was omitted).
- BRIEF.md (#57): toolchain floor said Swift 6 / Xcode 16+; the rest of the docs
  say Swift 6.2 / Xcode 26. Aligned.
- pi-canvas README (#57): "rendered once (cached)" contradicted the next sentence
  ("zooming re-rasterizes"); clarify "once per zoom level".

417 tests pass (+1). Docs + one small a11y fix; no behavior change to rendering.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014CJYAapHgDn2PWGNABnFtv
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

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: 39 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: 8b11db63-21ac-4c9d-87c2-b48440cd9a39

📥 Commits

Reviewing files that changed from the base of the PR and between 8a13d34 and 8b69e34.

📒 Files selected for processing (1)
  • docs/website/BRIEF.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fb23d3f9-ef7f-4374-a694-5917ec3f0314

📥 Commits

Reviewing files that changed from the base of the PR and between c5d781c and 8a13d34.

📒 Files selected for processing (5)
  • README.md
  • Sources/MermaidRender/DiagramRenderer.swift
  • Tests/MermaidRenderTests/FormatAwareEntryTests.swift
  • docs/website/BRIEF.md
  • tools/pi-canvas/README.md

Walkthrough

The parsed-diagram attachment path now includes non-empty titles in accessibility narration. Tests cover titled and untitled attachments. Documentation lists the format-aware PNG entry point and updates platform and canvas details.

Changes

Rendering and documentation

Layer / File(s) Summary
Caption-aware attachment narration
Sources/MermaidRender/DiagramRenderer.swift, Tests/MermaidRenderTests/FormatAwareEntryTests.swift
Attachment narration prefixes the diagram description with a supplied title. Tests cover titled and untitled attachments.
API and tool documentation
README.md, docs/website/BRIEF.md, tools/pi-canvas/README.md
README documents the format-aware PNG entry point. Platform requirements and per-zoom-level canvas caching descriptions are updated.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Poem

A rabbit hops through diagrams bright,
Titles now guide narration right.
PNG paths bloom in README air,
Zoom caches wait at levels fair.
“Swift six point two!” the bunnies cheer.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the accessibility caption and documentation fixes addressed by the pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/coderabbit-followups

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

…pot)

The doc-accuracy audit (Batch 1, #57) corrected the "Platforms:" bullet and the
"Apple platforms only today" caveat but missed the opening definition, which still
said MermaidKit "renders … natively on Apple platforms — pure Swift and
CoreGraphics" (the line wrapped across "natively on" / "Apple platforms", so the
audit's grep didn't catch it). Reword to the multi-platform reality (CoreGraphics
on Apple + Android/Windows/WASM/Flutter over the shared layout core) and add SVG
to the output list, matching the rest of the file.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014CJYAapHgDn2PWGNABnFtv
@clintecker
clintecker merged commit 765ba9f into main Aug 12, 2026
43 of 46 checks passed
@clintecker
clintecker deleted the fix/coderabbit-followups branch August 12, 2026 21:52
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.

1 participant