Skip to content

Manual menu: names match the home page, menu folds open, Previous/Next links - #354

Merged
txoof merged 1 commit into
mainfrom
350-menu-names
Oct 29, 2026
Merged

txoof merged 1 commit into
mainfrom
350-menu-names

Conversation

@txoof-bot

@txoof-bot txoof-bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #350, closes #343, closes #345

What changed

  • Names (reword menus to match the outline on index.md #350): the menu and each page's heading now use the names from "What's in this manual" on the home page: Getting started (Hardware, Install, First Setup, Web Interface, Update and Uninstall, Understanding Plugin Schedules, Troubleshooting, What's New), Plugins, Reference (Settings reference, Supported screens, How the service works) and For developers (Running from source, Writing a plugin, Plugin reference, Making a release). Links in the text that used the old names were renamed too.
  • Shorter menu (Side menu in docs is too long #343): the menu shows only Home, Getting started, Plugins, Reference and For developers; each one folds open with an arrow. The section of the page you are on is open. Plugins is its own section next to Getting started (the home page's outline now has a Plugins heading too), and its heading opens the plugin list.
  • Previous / Next (Getting Started should have a flow from step to step #345): every page ends with links to the page before and after it in the menu, so the Getting started steps can be followed one after the other.
  • "Waveshare screens" is still in the menu (it is not on the home page); remove multiple screen pages #352 merges it into "Supported screens".

One limit: on screens narrower than about 1220 pixels (most tablets and phones), the theme hides the menu behind the ☰ button. That is how Material for MkDocs works and cannot be changed with a setting.

Area

docs: docs/, mkdocs.yml, mkdocs_hooks.py (comment only).

Tests

  • uv run pytest passes (2395 passed)
  • uv run ruff check . passes
  • mkdocs build --strict passes (no broken links); checked the built site in a browser at 1400 pixels wide: folded menu, plugin pages under Plugins, Previous/Next at the bottom.

Review

  • Review agents' comments answered

Only txoof approves and merges this PR.

🤖 Generated with Claude Code

…t links (#350, #343, #345)

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 05:20
@txoof
txoof merged commit 7a4c49e into main Oct 29, 2026
4 checks passed
@txoof
txoof deleted the 350-menu-names branch October 29, 2026 05:43
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.

reword menus to match the outline on index.md Getting Started should have a flow from step to step Side menu in docs is too long

2 participants