Skip to content

Specifications part 2: screens and drivers, errors and time limits, web interface - #372

Merged
txoof merged 4 commits into
mainfrom
346-specs-2
Nov 9, 2026
Merged

txoof merged 4 commits into
mainfrom
346-specs-2

Conversation

@txoof-bot

Copy link
Copy Markdown
Collaborator

Closes #346

What changed

  • Three more specifications in docs/specs/, on the site under For developers → How PaperPi works, in the same shape as part 1 (Specifications part 1: config file, plugins, scheduling; old design notes moved to history #361):
    • Screens and drivers (screens.md), from display-driver-interface and it8951-driver: what every driver does, one write, fast / full / cleaning writes, colors, the virtual screen, start and stop, and the screen watchdog.
    • Errors, time limits and freezes (errors.md), from errors-and-time-limits and freeze-prevention: the 8 rules, the systemd watchdog and health file, what happens when things fail, time limits, logs, saved files, files on the SD card.
    • The web interface (web.md), from web-interface: how it is built, settings pages, pictures (previews, Library), logging in, safety. What each page does stays on the user page Web Interface.
  • Links: the code comments and install/paperpi.service that still pointed to these three notes in docs/history/decisions/ now point to the new specs.
  • With this, all 10 old design notes have a specification.

Checked against the code

Numbers come from limits.py, config.py and the web code. Two places where the old notes promised more than the code does are now under "Not built yet":

  • A summary line for an error that repeats ("same error repeated 40 times"): not in logbook.py.
  • A memory limit (MemoryMax=) in the systemd service.

Area

docs (docs/specs/, mkdocs.yml), plus comment-only changes in src/paperpi/ and install/paperpi.service.

Tests

  • Only docs and comments changed; no local runs, CI checks.
  • uv run pytest: CI
  • uv run ruff check .: CI
  • Site build with broken-link check: CI (docs workflow).

Review

  • Review agents' comments answered

Only txoof approves and merges this PR.

🤖 Generated with Claude Code

txoof-bot and others added 4 commits November 9, 2026 07:51
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…cations (#346)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@txoof-bot
txoof-bot requested a review from txoof as a code owner November 9, 2026 06:53
@txoof
txoof merged commit 6e28cdb into main Nov 9, 2026
4 checks passed
@txoof
txoof deleted the 346-specs-2 branch November 9, 2026 07:02
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.

Design Notes need to be formalized as specifications

2 participants