Phase 9 - Documentation UX and Consistency Cleanup¶

Scope¶

Phase 9 focuses on documentation polish after the main topic refactor phases.

The goal is to improve the reading experience and make the MkDocs site more consistent without changing the overall repository structure.

Changes¶

Replaced Unicode dash characters with ASCII hyphens in mkdocs.yml.
Removed unnecessary YAML quoting caused by colon usage in navigation titles.
Normalized Notes sidebar titles to be topic-oriented instead of day-oriented.
Kept Labs and Daily Logs day-oriented because those sections represent the learning timeline.

Layout and readability¶

Increased the maximum content width for engineering notes and code-heavy pages.
Preserved the existing green Material theme style.
Tuned content, navigation, and code block font sizing.

Reader font scaling¶

Added a client-side font size control:

A-  100%  A+  100%

Features:

Adjustable range: 50% to 200%.
Step size: 10%.
Uses localStorage to remember the reader's preference.
Applies scaling without rebuilding or reloading the site.
Keeps code block scaling within a safer range for readability.

Files Added¶

docs/assets/javascripts/font-scale.js
docs/meta/phase9-documentation-ux-consistency-cleanup.md

Files Updated¶

mkdocs.yml
docs/assets/stylesheets/extra.css

Verification¶

The site was verified with:

mkdocs build --strict

Result¶

The documentation site now has a cleaner navigation style, improved readability, and a user-adjustable font size control suitable for long-form technical reading.