Problem
The DAQIRI docs site at https://nvidia.github.io/daqiri/ currently renders in two distinct visual styles:
- MkDocs Material pages (
/api-guide/, /getting-started/, /configuration/, tutorials) use Material's default slate palette with a thin layer of NVIDIA-green overrides in docs/stylesheets/extra.css.
- Hand-written HTML pages (
/, /daqiri-api.html) ship their own embedded <style> block with a fully custom NVIDIA dark theme (Inter / JetBrains Mono typography, #0a0a0a background, custom card/sidebar styling).
The two coexist because MkDocs copies non-Markdown files in docs/ to the site root verbatim while rendering .md files through the Material theme. The visual disconnect makes the site feel like two products glued together.
Proposed change
Bring the Material-rendered pages visually in line with the hand-written HTML pages so the site reads as one design. Keep the HTML passthrough pages as-is — once Material adopts the same palette, the gap closes without touching them.
Scope:
mkdocs.yml: swap theme.font.text to Inter and theme.font.code to JetBrains Mono to match the custom pages (Material loads these from Google Fonts automatically).docs/stylesheets/extra.css: expand from a small accent override sheet to a comprehensive set of Material component overrides. Map the custom palette onto Material's documented CSS variables (--md-default-bg-color, --md-code-bg-color, --md-default-fg-color, etc.) and add rules for typography, code blocks, tables, navigation, buttons, and the note / warning / info / tip admonition variants. Shrink the typeset baseline and heading clamps to a tighter scale.
Out of scope (potential follow-ons)
- Migrating
docs/index.html and docs/daqiri-api.html to Markdown so URLs unify (.html vs trailing slash) and search indexes them.
- Generating
daqiri-api.html from Doxygen on include/daqiri/daqiri.h to eliminate hand-maintained API drift between it and docs/api-guide.md.
- A custom Material
home.html template with hero / feature-card partials to reproduce the landing-page layout natively in MkDocs.
Verification
mkdocs build --strict passes (matches the CI gate in .github/workflows/docs.yml).scripts/check_html_links.py site and scripts/check_doc_refs.py pass.- Visual diff:
/api-guide/ (Material-rendered) and /daqiri-api.html (custom) share palette, typography, and code-block styling. Same for /getting-started/ vs /.
- Platform tabs (IGX Orin / DGX Spark) on
/tutorials/system_configuration/ continue to work.
Problem
The DAQIRI docs site at https://nvidia.github.io/daqiri/ currently renders in two distinct visual styles:
/api-guide/,/getting-started/,/configuration/, tutorials) use Material's defaultslatepalette with a thin layer of NVIDIA-green overrides indocs/stylesheets/extra.css./,/daqiri-api.html) ship their own embedded<style>block with a fully custom NVIDIA dark theme (Inter / JetBrains Mono typography,#0a0a0abackground, custom card/sidebar styling).The two coexist because MkDocs copies non-Markdown files in
docs/to the site root verbatim while rendering.mdfiles through the Material theme. The visual disconnect makes the site feel like two products glued together.Proposed change
Bring the Material-rendered pages visually in line with the hand-written HTML pages so the site reads as one design. Keep the HTML passthrough pages as-is — once Material adopts the same palette, the gap closes without touching them.
Scope:
mkdocs.yml: swaptheme.font.textto Inter andtheme.font.codeto JetBrains Mono to match the custom pages (Material loads these from Google Fonts automatically).docs/stylesheets/extra.css: expand from a small accent override sheet to a comprehensive set of Material component overrides. Map the custom palette onto Material's documented CSS variables (--md-default-bg-color,--md-code-bg-color,--md-default-fg-color, etc.) and add rules for typography, code blocks, tables, navigation, buttons, and thenote/warning/info/tipadmonition variants. Shrink the typeset baseline and heading clamps to a tighter scale.Out of scope (potential follow-ons)
docs/index.htmlanddocs/daqiri-api.htmlto Markdown so URLs unify (.htmlvs trailing slash) and search indexes them.daqiri-api.htmlfrom Doxygen oninclude/daqiri/daqiri.hto eliminate hand-maintained API drift between it anddocs/api-guide.md.home.htmltemplate with hero / feature-card partials to reproduce the landing-page layout natively in MkDocs.Verification
mkdocs build --strictpasses (matches the CI gate in.github/workflows/docs.yml).scripts/check_html_links.py siteandscripts/check_doc_refs.pypass./api-guide/(Material-rendered) and/daqiri-api.html(custom) share palette, typography, and code-block styling. Same for/getting-started/vs/./tutorials/system_configuration/continue to work.