Skip to content

Plugin pages: a picture at the top, written for people - #359

Merged
txoof merged 20 commits into
mainfrom
357-plugin-pages
Oct 29, 2026
Merged

txoof merged 20 commits into
mainfrom
357-plugin-pages

Conversation

@txoof-bot

Copy link
Copy Markdown
Collaborator

Closes #357

What changed

  • Every plugin page now shows the plugin near the top. Each README starts with one short sentence, a line on when the plugin is shown (rotation or interrupt) and what it needs, then a picture of its default layout.
  • All 16 plugin READMEs rewritten in txoof's style (txoof reviewed and edited LMS, Spotify, Word clock, xkcd, Weather, Moon phase and Splash screen on this branch): What you need, Set it up (numbered steps in the web interface), Layouts (text table plus pictures of each layout), topic sections, When something is wrong, Settings with ### Configuration Keys, Credits where a license asks for it, and For developers at the end for the technical details and paperpi render commands. No "Sample images" section. American spelling.
  • On the website (src/paperpi/manual.py): a picture on its own line before a plugin page's first section gets { .preview }, styled in the new docs/stylesheets/extra.css as screen-sized (at most 560 px wide) with a thin frame, instead of the full page width. The "set up first: ..." line no longer ends with "..".
  • The web interface's Plugin Library leaves pictures out of READMEs as before, so the new top picture doesn't show there.

Area

docs and plugins: src/paperpi/plugins/*/README.md, mkdocs.yml, docs/stylesheets/extra.css, plus src/paperpi/manual.py (preview mark) and tests/test_manual.py.

Tests

  • New test_a_picture_before_the_first_section_is_the_plugins_preview.
  • uv run pytest passed after the first commit (2397 passed); the later commits change only README text, so CI checks them.
  • 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 20 commits October 29, 2026 07:50
…ure style for every plugin page (#357)

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>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…her pages (#357)

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>
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>
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>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@txoof-bot
txoof-bot requested a review from txoof as a code owner October 29, 2026 07:49
@txoof
txoof merged commit 245e9fe into main Oct 29, 2026
3 of 4 checks passed
@txoof
txoof deleted the 357-plugin-pages branch October 29, 2026 07:51
txoof-bot added a commit that referenced this pull request Oct 29, 2026
…rame too (fixes the failing test on main after #359)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.

individual plugin pages bury preveiw

2 participants