Skip to content

Modernize generated documentation site - #22

Merged
ikelaiah merged 4 commits into
mainfrom
docs/modern-documentation
Aug 10, 2026
Merged

Modernize generated documentation site#22
ikelaiah merged 4 commits into
mainfrom
docs/modern-documentation

Conversation

@ikelaiah

Copy link
Copy Markdown
Owner

Summary

  • add a responsive documentation shell with desktop and mobile navigation
  • render the release history as scannable cards
  • add accessible search, skip navigation, and persistent light/dark theme controls
  • make search work from the offline documentation ZIP without fetch
  • retain semantic tables, headings, lists, and release-version navigation

Why

The generated documentation was structurally correct after the v1.9.4 repairs, but its presentation and navigation still felt dated. This redesign gives the 79-page site a modern, readable, responsive interface while preserving dependency-free and offline operation.

Impact

Readers get clearer hierarchy, easier page navigation, keyboard-accessible search, responsive layouts, and system-aware theming. The release workflow and canonical Markdown sources remain unchanged.

Validation

  • python tools/test_build_docs.py — 8 tests passed
  • python tools/test_built_docs.py — 2 tests passed
  • python tools/check_docs.py — 79 pages passed documentation checks
  • generated 1.9.4 site passed tools/check_built_docs.py
  • node --check tools/docs_assets/search.js
  • visually checked generated output at 1440px desktop and 500px mobile browser widths

@ikelaiah ikelaiah self-assigned this Aug 10, 2026
@ikelaiah ikelaiah added the documentation Improvements or additions to documentation label Aug 10, 2026
@ikelaiah
ikelaiah marked this pull request as ready for review August 10, 2026 12:15
@ikelaiah
ikelaiah merged commit d28bb85 into main Aug 10, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant