docs: replace Graphviz SVG diagrams with inline Mermaid#47
docs: replace Graphviz SVG diagrams with inline Mermaid#47flyingrobots merged 4 commits intomainfrom
Conversation
Mermaid renders natively on GitHub with zero build step,
eliminating transparency, font, and scaling issues with
the old Graphviz SVGs.
- Convert 8 fig-* diagrams to inline Mermaid in README + GUIDE
- Delete docs/diagrams/ (17 files), docs/images/*.{dot,svg} (6 files)
- Delete scripts/build-diagrams.sh
- Bump version to 11.5.2
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughMigrates Graphviz-based diagrams to inline Mermaid blocks across README and GUIDE, removes generated diagram assets and the Graphviz build script, updates package and jsr versions to 11.5.3, and records the changes in CHANGELOG.md (notes for 11.5.3 and 11.5.2). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Release Preflight
If you tag this commit as |
Patch anatomy: add eg-state-hash/eg-frontier-oid trailers and operation parameter signatures. Materialize pipeline: add O(P) complexity note. Data-storage diagram: add visibility annotations. Ref layout: add elision nodes on leaf refs. CHANGELOG: correct 11.5.2 scope wording. Bump 11.5.2 → 11.5.3.
Release Preflight
If you tag this commit as |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@jsr.json`:
- Line 3: The CHANGELOG contains a spurious 11.5.2 entry that does not exist in
the JSR registry while jsr.json shows "version": "11.5.3"; reconcile them by
either collapsing the CHANGELOG's 11.5.2 content into the 11.5.3 entry and
removing the 11.5.2 heading, or explicitly annotate the CHANGELOG entry for
11.5.2 as an npm-only/intermediate release (and add a note) so it’s clear why
it’s absent from JSR; ensure jsr.json's "version" value ("11.5.3") remains
accurate and consistent with the published JSR releases.
11.5.2 was never published to npm or JSR. Merging both entries under 11.5.3 eliminates the version gap that confused the registry history. Resolves CodeRabbit review comment on jsr.json:3.
|
@coderabbitai review please 🥕 |
|
✅ Actions performedReview triggered.
|
Release Preflight
If you tag this commit as |
B-DIAG-1 through B-DIAG-3 (Mermaid migration checklist, rendering smoke test, invisible-link fragility) and B-REL-1/B-REL-2 (version consistency gate, preflight CHANGELOG cross-check). Sourced from PR #47 review session.
Release Preflight
If you tag this commit as |
1 participant
Summary
docs/diagrams/(8.dot+ 8.svg+style.dot),docs/images/*.{dot,svg}(6 files), andscripts/build-diagrams.shTest plan
Summary by CodeRabbit
Documentation
Chores