Skip to content

docs: let the shared styles bring the fonts - #489

Merged
shenxianpeng merged 1 commit into
mainfrom
chore/match-hub-fonts
Sep 25, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
chore/match-hub-fonts

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Sep 25, 2026 •

Copy link
Copy Markdown
Member

cpp-linter/cpp-linter.github.io#67 moves the hub's look (colors, light header, fonts) into the shared stylesheet these docs already load, so this site will match https://cpp-linter.github.io/ without changes of its own.

With the fonts coming from there, Material's default Roboto is downloaded and never used. This sets theme.font: false to stop loading it.

Merge after cpp-linter/cpp-linter.github.io#67 is deployed; before that, this site would fall back to the system font.

Checked with a local mkdocs build: the pages no longer request Google Fonts themselves and still load shared.css.

Summary by CodeRabbit

  • Style
    • Documentation pages now use fonts provided by the shared stylesheet instead of the MkDocs Material theme’s built-in font configuration. This changes the source of the fonts used across the documentation site while leaving other theme settings unchanged.

The shared styles from cpp-linter.github.io now carry the hub's look, fonts included, so Material's Roboto was downloaded and never used.
@shenxianpeng
shenxianpeng requested a review from a team as a code owner September 25, 2026 06:05
@shenxianpeng
shenxianpeng requested review from 2bndy5 and removed request for a team September 25, 2026 06:05
@coderabbitai

coderabbitai Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: b778b8bf-3fb6-40ec-bdb4-8ba89c324c70

📥 Commits

Reviewing files that changed from the base of the PR and between 57983f0 and b028c85.

📒 Files selected for processing (1)
  • mkdocs.yml

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


Walkthrough

The MkDocs Material theme configuration disables built-in fonts. A comment notes that the shared stylesheet supplies fonts.

Changes

Documentation theme configuration

Layer / File(s) Summary
Disable built-in theme fonts
mkdocs.yml
The theme’s font option is set to false. A comment notes that fonts are supplied by the shared stylesheet.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to b028c

No actionable merge-blocking issue is established; the documented font fallback is bounded and may be addressed with the shared stylesheet deployment.

Architecture Summary

Architecture risk: 🔵 Low · up to b028c

The change affects 1 system.

Changed systems: mkdocs.yml

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — mkdocs.yml (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in mkdocs.yml: Adds a comment about fonts being loaded from the shared stylesheet and sets the theme’s font option to false.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: shared styles provide the documentation fonts instead of Material's built-in font configuration.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@shenxianpeng shenxianpeng changed the title docs: stop loading Roboto now that the shared styles bring the fonts docs: let the shared styles bring the fonts Sep 25, 2026
@shenxianpeng

Copy link
Copy Markdown
Member Author

Because we do not have preview CI here. let's merge and see how it goes.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Sep 25, 2026
@shenxianpeng
shenxianpeng enabled auto-merge (squash) September 25, 2026 07:39

@2bndy5 2bndy5 left a comment •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fine now that cpp-linter/cpp-linter.github.io#67 was merged

@shenxianpeng
shenxianpeng merged commit 2f0561f into main Sep 25, 2026
9 of 10 checks passed
@shenxianpeng
shenxianpeng deleted the chore/match-hub-fonts branch September 25, 2026 14:49
2bndy5 pushed a commit to cpp-linter/cpp-linter-rs that referenced this pull request Sep 25, 2026
cpp-linter/cpp-linter.github.io#67 moved the hub's look (colors, light
header and fonts) into the shared stylesheet these docs already load. It
is live, so this site now uses the hub's self-hosted fonts.

Material's default Roboto is still requested from Google Fonts on every
page and never used. This sets `theme.font: false`, as
cpp-linter/cpp-linter-action#489 did.

Checked that `docs/mkdocs.yml` still parses with `theme.font` set to
false. The full docs build needs the Rust bindings, so it runs in CI.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Style**
* The documentation site now uses shared font styling rather than the
theme’s built-in font.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.

2 participants