Add favicon and status badges to the spec page - #6
Merged
Merged
Conversation
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
QA pass on the merged page (structural review: HTML validity, TOC-to- heading anchor consistency across all 63 sections, external resource availability -- all checked out clean) surfaced two real gaps versus the original curated landing page this replaced: - No favicon at all (generic/blank browser tab icon) -- added a small inline SVG data URI (no extra asset file), a rounded square with the site's own accent blue and a "P" mark. - The CI/license/Python-version badges from the original page's hero were dropped when the whole page became docs.md's content -- restored them, since they're a real trust signal for a page about to be shared publicly (build passing, license, supported Python version at a glance). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WSc9sb1otU6ssfxDBzeNHG
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Team Run ID: 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed and why
QA pass on the now-live spec page (structural review, not visual --
verified HTML validity, that every one of the 63 section headings has a
matching TOC link and vice versa, no duplicate anchor ids, and that
every external resource the page loads -- Google Fonts, MathJax,
Mermaid, the three badge images -- actually resolves). That surfaced two
real gaps versus the original curated landing page (#2) this replaced:
dropped when the whole page became
docs.md's content.Evidence
of a script run.
Favicon is an inline SVG data URI (no extra asset file): a rounded
square in the site's own accent blue with a "P" mark. Badges are the
same three the original page used (CI status, MIT license, Python
3.10+), restored as a trust signal for a page about to be shared widely.
Checklist
reproduce.yml) passes on this branch (docs-only change).data/meta_dataset.dbnot touched.referenced there -- N/A.
Open questions / requested feedback
None.