Skip to content

Improve peripheral documentation readability - #16

Merged
SirEdvin merged 3 commits into
1.20from
docs/peripheral-pages
Jul 16, 2026
Merged

Improve peripheral documentation readability#16
SirEdvin merged 3 commits into
1.20from
docs/peripheral-pages

Conversation

@SirEdvin

@SirEdvin SirEdvin commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Summary

  • redesign the TypeDoc reading layout for clearer typography, spacing, tables, and callouts
  • add player-facing peripheral cards and illustrated guide headers using the mod's block textures
  • generate player-facing method cards from TypeDoc interface reflections, including overloads, parameters, returns, and errors
  • keep guide-to-interface mapping declarative through Markdown front matter
  • add operational guidance for both digitizers
  • make cards, metadata, and reference tables responsive on mobile

Verification

  • npm run docs
  • git diff --check
  • verified generated guide pages and copied media assets exist

Testing note

  • browser screenshot testing was not available because the environment does not include the Playwright Python package

@SirEdvin
SirEdvin merged commit f1d0de9 into 1.20 Jul 16, 2026
2 checks passed
@SirEdvin
SirEdvin deleted the docs/peripheral-pages branch July 16, 2026 09:17
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