You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
mkdocs.yml inherits docs/overrides/.mkdocs-brand.yml and drops its local theme name, palette, logo, favicon and extra_css. It also enables md_in_html.
Result: the docs match the HSSM website, with an indigo header, navy dark mode, design-system code colours (notebook cells included), plots on a white card in dark mode, and no Google Fonts requests.
Home page: a new mainlogo-on-dark.png shows in dark mode. The design system has no on-dark LANS lockup, so it's derived the way the design system documents for hssm-logo-on-dark.png: the wordmark is recoloured from indigo to teal, alpha kept. The same script reproduces the official HSSM on-dark file pixel for pixel. Worth a look from the design-system owner.
The BRAINSTORM mark sits on a white plate in dark mode, and all three landing images have alt text.
A high-effort review of this change found 9 issues in the shared bundle. They're fixed upstream in lnccbrown/HSSMSpine#188 and included here.
Verified with ./scripts/docs.sh build (strict, no warnings), browser checks of the home page, a notebook, an API page and a table in light and dark, and the pre-commit hooks.
- vendor HSSMSpine docs-brand (tokens.css, extra.css, overrides,
IBM Plex fonts) byte-for-byte
- mkdocs.yml inherits docs/overrides/.mkdocs-brand.yml; drop the local
theme name, palette, logo, favicon and extra_css it now owns; enable
md_in_html
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- add mainlogo-on-dark.png: the LANS lockup with its wordmark recoloured
from indigo (wave-03) to teal (wave-13), alpha kept, the same derivation
the design system documents for hssm-logo-on-dark.png
- show it in dark mode (#only-light / #only-dark); put the BRAINSTORM
mark on a white plate in dark mode; add alt text to all three images
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
No actionable comments were generated in the recent review.
Walkthrough
The documentation now inherits shared MkDocs brand configurations. New design tokens define fonts, colors, and layout values. Styles apply these tokens to documentation, landing-page, and notebook components. Page and footer markup uses theme and package identity classes.
Changes: Shared documentation branding
Layer / File(s)
Summary
Font, token, and MkDocs foundation docs/styles/tokens.css, docs/fonts/OFL.txt, docs/overrides/.mkdocs-brand*.yml, mkdocs.yml
Adds IBM Plex font faces and HSSM design tokens, includes the IBM Plex Sans Italic license, and configures shared theme settings and stylesheet variants. The local MkDocs configuration adds md_in_html and removes settings supplied by the shared configuration.
Maps Material and documentation components to HSSM tokens. Adds theme, landing-page, and notebook styling, including responsive cards, focus styling, and reduced-motion rules.
Page and footer branding docs/index.md, docs/overrides/main.html, docs/overrides/partials/ecosystem-links.html
Updates landing-page image markup and light- and dark-mode logos. Wraps footer content in theme classes and adds package identity classes to ecosystem links; their URLs and labels remain unchanged.
This change applies a shared documentation theme through MkDocs configuration, CSS and template markup. No behavioral risk was identified. The CI lint failure is in unrelated source code and does not come from this PR.
Pre-merge checks: 4
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title "docs: adopt the shared design-system theme" matches the main change. The PR vendors the shared docs-brand theme bundle and configures MkDocs to inherit it, and the changed files (extra.css,…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title "docs: adopt the shared design-system theme" matches the main change. The PR vendors the shared docs-brand theme bundle and configures MkDocs to inherit it, and the changed files (extra.css, tokens.css, mkdocs.yml, brand override YAML files) all implement that theme adoption. The title is concise, uses the conventional docs: prefix, and names the primary change.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
The reason will be displayed to describe this comment to others. Learn more.
🟢 Approval recommended
The documentation theme and styling changes have no active review issues.
No open issues 🎉
What changed in this PR
Aligns LANfactory’s documentation with the shared HSSM design system by adopting HSSMSpine’s theme bundle. Changes are limited to documentation presentation and configuration.
Changes:
Inherits shared Material theme settings and configures self-hosted IBM Plex fonts instead of Google Fonts.
Applies design-system colours and styling to navigation, notebooks, tables, focus indicators, and the footer.
Adds theme-specific landing-page logos, a dark-mode background for the BRAINSTORM mark, and image alt text.
File
Description
mkdocs.yml
Inherits shared theme configuration and enables md_in_html.
docs/styles/tokens.css
Adds generated design tokens and self-hosted font declarations.
docs/styles/extra.css
Maps shared tokens to Material components and notebook styling.
docs/overrides/partials/ecosystem-links.html
Adds package-specific colour classes to ecosystem links.
docs/overrides/main.html
Wraps the footer in a consistently dark theme.
docs/overrides/.mkdocs-brand.yml
Defines shared theme, palette, asset, and stylesheet settings.
docs/index.md
Selects light/dark logos and adds image accessibility attributes.
docs/fonts/OFL.txt
Includes the license for the bundled IBM Plex fonts.
- picks up lnccbrown/HSSMSpine#188 review fixes: relative heading and
code sizes, scheme-toggle and tab focus rings, non-scrolling tab
gradient, footer hover, wave favicon, latin-ext/greek and italic
IBM Plex faces, notebook and landing styles split into opt-in files
- mkdocs.yml inherits the notebooks base variant (.mkdocs-brand-notebooks.yml)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Picks up the lnccbrown/HSSMSpine#188 review fixes: table code keeps the
table's size, underlined announcement links, a higher-contrast secondary
button outline, and figure cards that cannot overflow the column.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
documentationImprovements or additions to documentation
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs-brandbundle byte-for-byte: generatedtokens.css,extra.css, overrides and self-hosted IBM Plex. It depends on lnccbrown/HSSMSpine#188, which should merge first. The same theme is in docs: adopt the shared design-system theme HSSM#1501 and docs: adopt the shared design-system theme ssm-simulators#429.mkdocs.ymlinheritsdocs/overrides/.mkdocs-brand.ymland drops its local theme name, palette, logo, favicon andextra_css. It also enablesmd_in_html.mainlogo-on-dark.pngshows in dark mode. The design system has no on-dark LANS lockup, so it's derived the way the design system documents forhssm-logo-on-dark.png: the wordmark is recoloured from indigo to teal, alpha kept. The same script reproduces the official HSSM on-dark file pixel for pixel. Worth a look from the design-system owner.alttext../scripts/docs.sh build(strict, no warnings), browser checks of the home page, a notebook, an API page and a table in light and dark, and the pre-commit hooks.🤖 Generated with Claude Code
Summary by CodeRabbit