Skip to content

README as a short landing page; details move to the site's Guide page - #10

Merged
davidquarel merged 4 commits into
sitefrom
readme-minimal
Sep 17, 2026
Merged

davidquarel merged 4 commits into
sitefrom
readme-minimal

Conversation

@davidquarel

Copy link
Copy Markdown
Collaborator

What

The README is now a landing page, 27 lines: one-liner, three badges (docs site, Colab, tests), the demo GIF, the install line, a six-line example, one paragraph on what it is, and links into the site. Everything it used to hold moves, in the same order, to docs/guide.md, which the site shows as Guide between Home and API: nested loops, the x-axis, options, the matplotlib-style setters, reference lines, smoothing, how it works.

Verified

Site builds strict-clean with the four pages (Home, Guide, API, Examples).

Merge order

This branch contains #7 (axes-api) and #9 (site, which contains #8) because all three touch the README. Merge #7, #8, #9 first, with merge commits rather than rebase-merges, and this reduces to the README and Guide change. If you'd rather, merge those three and say so; I'll rebase this onto main in a minute.

🤖 Generated with Claude Code

https://claude.ai/code/session_01G9zs684RFxHvW6cNWqTPSF

davidquarel and others added 4 commits September 17, 2026 12:38
plot[metric] is the y-axis holding that metric (left or right), and
plot.panels[i] a panel; both take matplotlib's own setter names and
signatures: set_ylabel, set_ylim (two args or a tuple), set_yscale,
axhline on an axis; set_title, set_xlabel, set_xlim, set_smooth, axvline
on a panel; set(**kwargs) on both, like Axes.set; and the same on the
plot itself for every panel (also as the default for panels created
later). A setter called mid-run re-lays the figure out on the next
frame. Vertical lines can now be per-panel as well as plot-wide. The
dict panel spec is still accepted but the README and tour lead with
the setters.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01G9zs684RFxHvW6cNWqTPSF
…page

The README is now 27 lines: one-liner, badges (docs, Colab, tests), the
demo GIF, install, a six-line example, a paragraph on what it is, and
links into the site. Everything else it used to hold (nested loops, the
x-axis, options, the matplotlib-style setters, reference lines,
smoothing, how it works) is docs/guide.md, in the same order, which the
site shows as "Guide" between Home and API.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01G9zs684RFxHvW6cNWqTPSF
@davidquarel
davidquarel merged commit 4b981d0 into site Sep 17, 2026
3 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