Skip to content

🟠 Fix content inconsistencies across docs (BOM voltage, comparison table, sitemap, attribution) #27

Description

@drewferg11-hermes-bot

Goal

Fix four content inconsistencies found in the site review where the docs contradict each other or are incomplete.

Issues found

1. 🟠 BOM says "120V wiring" but project supports worldwide voltage

File: docs/build/dual-display/bom.md

The Common table lists 16 AWG Wire with notes "Red and black for 120V wiring". But the power page and PSU specs say input is 85–264V AC (worldwide), and the disclaimer says 110/240V.

Fix: Change to "Red and black for AC mains wiring" or "120V/240V wiring".

2. 🟠 Build comparison table footnotes are misleading

File: docs/build/index.md

The "Which build is right for you?" table shows Supports 48 flaps: Original = ✅ with no caveat, but footnote [^2] says "Square enclosure (currently) only supports 37. Original (rounded) enclosure supports both counts." Same issue with footnote [^3] ("Enhanced flap accuracy — only comes with the square enclosure") — the table shows ✅ for both but it's square-enclosure-only.

Fix: Add footnote markers to the affected cells so readers know the ✅ is conditional.

3. 🟠 Sitemap.md is missing itself

File: docs/sitemap.md

The page says "Every page in this documentation at a glance" but doesn't list "Site Map" itself, while mkdocs.yml nav includes it under Home.

Fix: Add - [Site Map](sitemap.md) to the Home section.

4. 🟠 Attribution inconsistency between README and docs index

File: docs/index.md vs README.md

The docs index says the project "builds on the original hardware design by Morgan Manly" — it doesn't mention the fork chain (ManlyMorgan → jhoff → DrewFerg11). The README correctly says "Forked from jhoff/Split-Flap-Display, which builds on the original hardware design by Morgan Manly."

Fix: Consider adding "based on the fork by Jordan Hoff (jhoff), which builds on the original design by Morgan Manly" to the docs index credits.

Acceptance criteria

  • BOM wire description is voltage-agnostic or says "120V/240V"
  • Comparison table cells have footnote markers where the ✅ is conditional
  • Sitemap includes all pages from the mkdocs.yml nav
  • Docs index credits match the README's attribution accuracy
  • mkdocs build --strict passes

Files / areas involved

  • docs/build/dual-display/bom.md
  • docs/build/index.md
  • docs/sitemap.md
  • docs/index.md

Constraints

  • Don't remove the footnotes — add markers to the table cells
  • Keep the sitemap's existing structure and ordering

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhermes-taskStructured task. Hermes does not act on this by itself.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions