Skip to content

Rework zoduki assembly pages, fix sidebar nav on new sections - #11

Open
Jerome-Cooper wants to merge 2 commits into
mainfrom
zoduki-rework
Open

Jerome-Cooper wants to merge 2 commits into
mainfrom
zoduki-rework

Conversation

@Jerome-Cooper

Copy link
Copy Markdown
Collaborator

Summary

Zoduki page rework (existing pages):

  • Capped every zoduki step at 4 or fewer top-level items (bullets and numbered list items alike) across existing pages, splitting oversized steps into multiple, sensibly-titled ones so pages don't render with too many simultaneous step colors at once.
  • Fixed a content-loss bug: any markdown sitting outside a ### step div was being silently dropped from the rendered page once zoduki activated on it. Worst case was lumen/control-box, where most of the page's content was invisible. Restructured affected pages so everything lives inside a step and actually renders.

New sections converted to zoduki:

  • Converted "v4 Upgrade Parts", "v2/v3 Spare Parts", and "DIY Components" assembly guide pages to the interactive step-by-step zoduki format, matching the rest of the site.
  • Gave the still-unwritten "Endstop PCB Set" page a real title instead of falling back to "Index" (content is still a placeholder — no instructions invented).

Sidebar navigation fix:

  • The pages above were never wired into mkdocs.yml's nav: tree (they sat in a long-dead commented-out block), so they had no left-sidebar navigation regardless of page frontmatter. Wired them in as a nested "Other Products" group, removed a leftover hide: navigation frontmatter key that was an inconsistent copy-paste artifact on 17 of those pages, and dropped the dead commented-out nav block.

All changes verified with a clean mkdocs build (no new errors) and spot-checked in a browser.

Test plan

  • mkdocs build runs clean, no errors
  • Verified in browser that previously-hidden content (e.g. lumen/control-box) now renders
  • Verified sidebar navigation now appears on all newly-converted pages
  • Confirmed no zoduki step exceeds 4 top-level items anywhere on the site

- Cap every zoduki step at 4 or fewer top-level items (bullets and
  numbered list items alike) across existing pages, splitting oversized
  steps into multiple, sensibly-titled ones so pages don't render with
  too many simultaneous step colors.
- Fix a content-loss bug in the zoduki plugin's interaction with existing
  docs: any markdown sitting outside a `###` step div was being silently
  dropped from the rendered page once zoduki activated. Restructured
  affected pages (worst case: lumen/control-box, where most of the page
  was invisible) so all existing content lives inside a step and survives
  rendering.
- Convert the "v4 Upgrade Parts", "v2/v3 Spare Parts", and "DIY
  Components" assembly guide sections to the interactive zoduki
  step-by-step format, matching the rest of the site.
- Give the still-unwritten Endstop PCB Set placeholder a real page title
  instead of falling back to "Index".
- Add the "Other Products" accessory pages to the site nav.
The DIY Components, v2/v3 Spare Parts, and v4 Upgrade Parts pages were
never wired into mkdocs.yml's nav tree (they sat in a dead commented-out
block), so mkdocs-material had no nav context to render in the left
sidebar regardless of page frontmatter. Removed the leftover
`hide: navigation` frontmatter on 17 pages where it was an inconsistent
copy-paste artifact (kept it on the two genuine full-bleed landing
pages), added the three sections as a nested "Other Products" nav group
mirroring assembly-guides/index.md's structure, dropped the stale
commented-out nav block, and fixed one nav entry that referenced an
in-page anchor mkdocs nav doesn't support.

This branch has not been deployed

No deployments
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