Skip to content

Release DocSprout v1.5.0: theme quality - #60

Merged
ikelaiah merged 2 commits into
mainfrom
dev/v1.5.0
Nov 6, 2026
Merged

ikelaiah merged 2 commits into
mainfrom
dev/v1.5.0

Conversation

@ikelaiah

@ikelaiah ikelaiah commented Nov 5, 2026

Copy link
Copy Markdown
Owner

Theme-quality minor release. It fixes the three P1 issues and the contrast failures from a design critique of all four styles (Classic, Paper, E-ink, Glassmorphic) in Light and Dark.

Contrast (all styles and modes)

  • Callout labels meet WCAG AA. Dark-mode labels were 2.6–4.2:1 and are now 6.9–11.6:1. Light-mode "note" was 3.6–3.9:1 and now passes; the lowest light value is 4.74:1. The colours are internal --dk-callout-* tokens.
  • The search placeholder uses --dk-muted. The browser default had failed in all 8 combinations.
  • Focus rings are drawn inside links in the scrolling sidebar and outline, so they are no longer clipped. On code blocks they use --dk-code-text; Paper Light's copy-button ring goes from 2.65:1 to 11.7:1.

E-ink is ink-only

  • A body rule maps the accent, link, focus and button tokens to the text colour. The palette generator no longer emits E-ink entries.
  • Callouts differ by rule and marker shape: thin, dashed, double, framed. Syntax highlighting uses weight only.
  • A browser scan of every visible element on 4 pages, at phone and desktop widths, in light and dark, found no visible colour apart from page content.

Reading measure and code

  • --dk-reading-width is set in ch: compact 54, comfortable 60 and wide 64, with narrower Paper values because Georgia's digits are narrow. Measured plain prose is 58–73 characters per line in every style and width. It was up to about 99 before.
  • Code blocks follow the style. Paper prints code on the page in warm, muted colours (each at least 5.4:1) and keeps dark panels in Dark mode. Glassmorphic uses a frosted panel. Window dots appear only in Classic.

Also fixed: top-level pages in the phone menu were browser-default blue in every style.

Release prep: version 1.5.0, v1.5.0 pins, docs/versions.json, the changelog, the migration guide (v1.4.1 to v1.5.0, noting the three visible changes), the qualification page and the roadmap.

Checklist

  • Tests pass: python -m unittest discover -s tests -t . (355 tests, run with PYTHONPATH=src)
  • Documentation checks pass: docsprout check and docsprout audit --strict (0 errors, 0 warnings)
  • Guides, examples or migration notes updated when behaviour changes
  • For a release: version metadata, CHANGELOG.md, docs/versions.json and workflow pins updated together
  • No secrets, tokens or credentials added

The wheel and sdist each passed qualification_installed.py --expected-version 1.5.0 in a fresh virtual environment. doctor reports only the expected missing v1.5.0 tag. After merge: create the annotated tag v1.5.0 on the merge commit, run check-release and build-all, push the tag, then publish the GitHub Release.

- Callout labels meet WCAG AA in every style and colour mode.
- The search placeholder uses the muted text colour.
- Focus rings are no longer clipped in the sidebar and outline, and use the
  code text colour on code blocks.
- E-ink is ink-only: links, focus, buttons, navigation, icons and syntax use
  the text colour. Callouts differ by rule and marker shape.
- Top-level phone menu pages use the text colour, not default link blue.
- The reading measure is set in ch, keeping 58-73 characters per line.
- Code blocks follow the style: printed warm code in Paper, frosted panels
  in Glassmorphic, window dots in Classic only.
@ikelaiah
ikelaiah merged commit 25eb203 into main Nov 6, 2026
47 of 48 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