Skip to content

#206 - Docs website cleanup: nav, mobile toggle, header, and prose#227

Merged
dleshchev merged 1 commit into
mainfrom
ccrozier/docs-fixes
Jul 15, 2026
Merged

#206 - Docs website cleanup: nav, mobile toggle, header, and prose#227
dleshchev merged 1 commit into
mainfrom
ccrozier/docs-fixes

Conversation

@chloecrozier

@chloecrozier chloecrozier commented Jul 15, 2026

Copy link
Copy Markdown
Member

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

  • Fix 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. Replaced it with a simple two-state toggle that defaults to dark and switches dark, light, dark
  • Fix landing header title on scroll. The site title and page title were identical, so Material slid the same text sideways when scrolling from the top. The landing header now shows one static title
  • Remove duplicate Previous/Next nav. Pages had hand-written Previous/Next links that duplicated (and disagreed with) the theme's built-in footer nav. Kept the theme footer as the single source
  • Shorten the site title. Uses a colon ("DAQIRI:") instead of a dash. It is shorter and reads more cleanly, including for screen readers
  • Drop em dashes and prose semicolons across the docs. Rewrote them as commas, periods, or parentheses
  • Shorter clauses are easier to read and are announced more predictably by screen readers. Code blocks are untouched
  • Plainer wording. Toned down a few marketing-style sentences on the landing page.
  • Small grammar fix. "a NVIDIA" to "an NVIDIA" for consistency

Test plan

  • mkdocs build --strict passes (only the pre-existing packet-diagram image warnings, which CI generates)
  • scripts/check_html_links.py site passes
  • scripts/check_doc_refs.py passes
  • Reviewer: UI looks good locally

@greptile-apps

greptile-apps Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR cleans up the DAQIRI documentation website (issue #206) by fixing two UI bugs, removing duplicate navigation, simplifying the site title, and making prose easier to read across all docs pages. No source code or build files are touched.

  • UI fixes: Removes media attributes from the MkDocs palette so the dark/light toggle works as a user-controlled two-state switch (defaults to dark), and adds a small CSS block to prevent the landing page header from animating a duplicate title on scroll.
  • Navigation cleanup: Removes hand-written Previous/Next footer blocks from five benchmark/tutorial pages that duplicated and sometimes disagreed with the theme's built-in footer nav.
  • Prose cleanup across 19 .md and HTML files: Replaces em dashes and prose semicolons with commas, periods, or parentheses; tones down marketing language on the landing page; fixes "a NVIDIA" → "an NVIDIA".

Confidence Score: 5/5

Safe to merge — docs-only change with no source or build file modifications.

All changes are documentation prose, CSS, YAML site config, and HTML landing templates. The previous-review concern about benchmarks/benchmarks.md conflicting with the base-branch rename is resolved: the HEAD commit edits benchmarks/index.md and mkdocs.yml correctly points to that file. The commit carries a valid DCO trailer and follows the #206 - Title format.

No files require special attention.

Important Files Changed

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

@chloecrozier
chloecrozier force-pushed the ccrozier/docs-fixes branch from 6a1e5ba to b232ebc Compare July 15, 2026 20:59
@chloecrozier
chloecrozier requested review from RamyaGuru and dleshchev and removed request for RamyaGuru July 15, 2026 21:00
@dleshchev

Copy link
Copy Markdown
Collaborator

The landing header override hides the second .md-header__topic, but Material still toggles .md-header__title--active after scrolling past the H1. That active rule also sets the first topic to pointer-events: none and z-index: -1, while this override only restores opacity/transform. Could you also reset pointer-events and z-index here, or otherwise disable the active title state on the landing page?

- 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>
@chloecrozier
chloecrozier force-pushed the ccrozier/docs-fixes branch from b232ebc to 73775bb Compare July 15, 2026 22:35
@chloecrozier

Copy link
Copy Markdown
Member Author

@dleshchev I addressed your comment!

@dleshchev
dleshchev merged commit afae5e4 into main Jul 15, 2026
3 checks passed
@dleshchev
dleshchev deleted the ccrozier/docs-fixes branch July 15, 2026 22:40
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.

2 participants