#206 - Docs website cleanup: nav, mobile toggle, header, and prose#227
Conversation
|
| Filename | Overview |
|---|---|
| mkdocs.yml | Fixes the light/dark toggle by removing media-query bindings (now a proper two-state toggle defaulting to dark/slate), and shortens the site name from em-dash to colon style. |
| docs/stylesheets/landing.css | Adds CSS rules to suppress Material's scroll-swap animation on the landing page, preventing the duplicate site/page title from sliding sideways on scroll. |
| docs/index.md | Updates page title from em-dash to colon style to match the new site_name in mkdocs.yml. |
| docs/benchmarks/index.md | Removes hand-written Previous/Next footer block and replaces a bare em-dash cell with n/a in the stream-type table; prose semicolons replaced with commas. |
| docs/benchmarks/raw_benchmarking.md | Removes Previous/Next footer block; replaces em dashes and semicolons with commas or periods throughout. Code blocks and YAML are untouched. |
| docs/tutorials/configuration-walkthrough.md | Removes Previous/Next footer block and converts all em-dash list separators and inline semicolons to colons, commas, or periods. Extensive prose cleanup with no technical changes. |
| docs/landing/features.html | Replaces marketing-heavy intro paragraph with plainer language; em dashes in feature cards replaced with commas. |
| docs/tutorials/system_configuration.md | Fixes a NVIDIA to an NVIDIA grammar; replaces em dashes in table cells and inline prose with commas or periods; removes Previous/Next footer blocks in both platform tabs. |
Reviews (4): Last reviewed commit: "#206 - Docs website cleanup: nav, mobile..." | Re-trigger Greptile
6a1e5ba to
b232ebc
Compare
|
The landing header override hides the second |
- Fix the mobile light/dark toggle. The palette had two entries both bound
to prefers-color-scheme, so tapping the button only mirrored the OS
setting and appeared to do nothing. Use a simple two-state toggle that
defaults to dark and switches dark, light, dark.
- Fix the landing header title on scroll. The site title and page title
are identical, so Material slid the same text sideways when scrolling
from the top. Keep a single static title on the landing page.
- Remove hand-written Previous/Next blocks that duplicated and
contradicted the theme's built-in footer navigation.
- Shorten the site title to use a colon ("DAQIRI:") instead of a dash.
- Remove em dashes and prose semicolons across the docs and landing
pages, rewriting them as commas, periods, or parentheses for shorter,
more readable clauses. Code blocks are left untouched.
- Tone down a few marketing-style landing sentences and fix "a NVIDIA"
to "an NVIDIA" for consistency.
Signed-off-by: Chloe Crozier <chloecrozier@gmail.com>
b232ebc to
73775bb
Compare
|
@dleshchev I addressed your comment! |
Summary
Docs cleanup for the website (issue #206). Fixes two visible UI bugs, removes and obvious ai-speak, and keeps the wordage simple and clear
Changes
prefers-color-scheme, so tapping the button only mirrored the OS setting and appeared to do nothing. Replaced it with a simple two-state toggle that defaults to dark and switches dark, light, darkTest plan
mkdocs build --strictpasses (only the pre-existing packet-diagram image warnings, which CI generates)scripts/check_html_links.py sitepassesscripts/check_doc_refs.pypasses