Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ keywords:
- multivariate data analysis
- batch data analysis
license: CC-BY-SA-4.0
version: "2026.08.03"
date-released: 2026-08-03
version: "2026.09.05"
date-released: 2026-09-05
repository-code: "https://github.com/kgdunn/pid-book"
url: "https://learnche.org/pid"
identifiers:
Expand Down
25 changes: 25 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,31 @@ The full design, build wiring, runtime behaviour, server pipeline, and
operations cookbook live in [`docs/telemetry/`](docs/telemetry/). Read
`docs/telemetry/README.md` first; it links to the rest.

## Review renders (HTML artifacts of a chapter)

When a draft chapter is shown for review as a standalone HTML artifact
(the Sphinx body repackaged with figures embedded and MathJax inlined),
the page must never require horizontal scrolling, at any zoom level.
The author reads at 150% zoom, which shrinks the layout viewport to
roughly 700 CSS pixels, so a fixed reading-column width that looks fine
at 100% will push the page sideways.

Rules for these renders:

- Give the reading column `max-width: min(<measure>, 100%)`, never a
bare `max-width` in `rem` or `px`.
- Grid and flex tracks holding the article need `minmax(0, 1fr)` and
`min-width: 0`; the default `min-width: auto` lets a wide descendant
stretch the track past the viewport.
- Code blocks wrap (`white-space: pre-wrap; overflow-wrap: break-word`)
rather than scrolling horizontally.
- Prose, links, inline literals and table cells get
`overflow-wrap: break-word` (`anywhere` for URLs), so a long DOI link
cannot widen the page.
- Verify, do not assume: load the file in headless Chromium and check
that `document.documentElement.scrollWidth` equals `clientWidth` at
375, 700, 1024 and 1440 pixels wide before publishing.

## Chapter rework playbook

A repeatable pattern for sweeping a chapter (or numbered subsection)
Expand Down
Loading
Loading