Skip to content

Replace ASCII architecture diagrams with colored Mermaid diagrams - #5

Merged
rustnew merged 1 commit into
mainfrom
docs/mermaid-diagrams
Sep 3, 2026
Merged

rustnew merged 1 commit into
mainfrom
docs/mermaid-diagrams

Conversation

@rustnew

@rustnew rustnew commented Sep 3, 2026

Copy link
Copy Markdown
Owner

What changed and why

Follow-up to #4 (merged before this change landed -- same content,
rebased onto current main). The 14 ASCII-art diagrams in docs.md
(§8, §9.5, §9.9-9.10, §9.15, §12-14, §17, §19.1, §25 x3, §29) render as
literal monospace text and don't scale to a public launch page. Replaced
with equivalent Mermaid flowcharts (a quadrant chart for §9.9's Pareto
front), colored via per-diagram classDef (soft red = reject/stop, green
= confirm/ground-truth, blue = terminal "next generation" states).

Evidence

  • N/A (presentation-only PR) -- content unchanged, every diagram
    carries the exact same nodes/flow as its ASCII original.
  • No claim differs: nothing here changes what any diagram says, only
    how it's drawn.
  • N/A -- no negative result introduced here.

Colors are defined per-diagram via classDef (not page-level CSS), so
they render correctly and consistently both on the built GitHub Pages
site and natively when viewing docs.md directly on GitHub. Plain
example-output/list blocks that aren't actually diagrams (learning-rate
output example, failure-category list, TRAIN/VAL/TEST description,
baseline comparison list) are intentionally left as plain code blocks.

docs/index.html regenerated from docs.md via the existing build
script, extended to convert Python-Markdown's fenced-code Mermaid output
into the <pre class="mermaid"> shape mermaid.js expects, plus a
page-level mermaid.initialize() call (theme matched to the site's
palette) loaded from jsdelivr.

Checklist

  • CI (reproduce.yml) passes on this branch (docs-only change).
  • No claim in this PR is asserted without a script/report backing it.
  • data/meta_dataset.db not touched.
  • README/docs.md updated if this PR changes a number or conclusion
    referenced there -- N/A, no numbers or conclusions changed.

Open questions / requested feedback

None -- straightforward presentation change. Flagging only that this
branch was rebased onto current main because #4 merged mid-flight;
the diff here is identical in substance to what was originally pushed to
docs/full-spec-page.

Requested ahead of the wider Reddit launch: the ASCII-art pipeline/tree
diagrams throughout docs.md (§8, §9.5, §9.9-9.10, §9.15, §12-14, §17,
§19.1, §25 x3, §29 -- 14 diagrams total) render as literal monospace text
and don't scale to a public page. Replaced with equivalent Mermaid
flowcharts (a quadrant chart for §9.9's Pareto front), colored via
per-diagram `classDef` (soft red for reject/stop states, green for
confirm/ground-truth states, blue for terminal "next generation" states)
so every diagram is self-contained and renders correctly and consistently
both on the built page and natively on GitHub when viewing docs.md
directly -- no page-specific styling required to read it correctly.

Content is unchanged: every diagram carries the exact same nodes and
flow as its ASCII original, just structured and colored instead of
hand-drawn with box-drawing characters. Plain example-output and list
blocks that aren't actually diagrams (the learning-rate output example,
the failure-category list, the TRAIN/VAL/TEST description, the baseline
comparison list) are intentionally left as plain code blocks -- forcing
those into Mermaid would add structure that isn't there.

docs/index.html regenerated from docs.md via the existing build script,
extended to convert Python-Markdown's `<pre><code class="language-
mermaid">` fenced-code output into the `<pre class="mermaid">` shape
mermaid.js expects, plus a page-level mermaid.initialize() call (theme
matched to the site's existing palette) loaded from jsdelivr.

Rebased onto main after PR #4 (docs/full-spec-page) merged before this
change was pushed -- this is the same diff, targeted at current main.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WSc9sb1otU6ssfxDBzeNHG
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 8e0ade2b-8518-47e2-8aae-edb1d7082f20


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.

❤️ Share

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

@rustnew
rustnew merged commit 3e2a032 into main Sep 3, 2026
2 checks passed
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