Skip to content

Feature: Theme and hub re-design - #104

Merged
mbenavidez-amd merged 5 commits into
ROCm:developfrom
mbenavidez-amd:feature/hub-redesign
Jul 13, 2026
Merged

Feature: Theme and hub re-design#104
mbenavidez-amd merged 5 commits into
ROCm:developfrom
mbenavidez-amd:feature/hub-redesign

Conversation

@mbenavidez-amd

@mbenavidez-amd mbenavidez-amd commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Motivation

This pull request makes significant improvements to the documentation site, focusing on a redesigned landing page, improved navigation, and enhanced visual presentation. It introduces a new landing page layout with visually consistent cards, moves cluster validation content to its own overview page, updates theme and copyright information, and adds custom CSS for a better user experience. There are also updates to wordlists and build configurations to support these changes.

Technical Details

Landing page and site structure improvements:

  • Completely redesigned the documentation landing page (docs/index.rst) using custom HTML and CSS for a modern, card-based layout, with direct links to key guides and reference materials. The original cluster validation content was moved to a new docs/overview.rst page for clarity and better organization. [1] [2]
  • Updated the site navigation by adding the new overview page to the table of contents (docs/sphinx/_toc.yml, docs/sphinx/_toc.yml.in).

Visual and theme enhancements:

  • Added custom CSS (docs/_static/css/custom.css) to disable scroll-reveal animations, clamp card text for uniformity, and hide the sidebar toggle when the sidebar is empty.
  • Changed the Sphinx theme flavor to instinct-design and updated sidebar behavior to hide it only on the landing page (docs/conf.py).
  • Updated copyright year and site title for accuracy and branding.

Build and configuration updates:

  • Improved the Read the Docs build guard to more reliably detect changes to documentation and only build when needed (docs/.readthedocs.yaml).
  • Added a new Read the Docs configuration for the data center design docs (infrastructure/dc-design/.readthedocs.yaml).

Styling for data center design docs:

  • Added custom CSS to the data center design documentation for image handling, sidebar toggle, and legal text styling (infrastructure/dc-design/_static/css/custom.css).

These changes collectively modernize the documentation’s appearance, improve navigation and maintainability, and lay the groundwork for further content expansion.

Test Plan

Test and validate local build of documentation.

Test Result

  • Documentation builds successfully

Submission Checklist

@mbenavidez-amd mbenavidez-amd self-assigned this Jul 13, 2026
@mbenavidez-amd mbenavidez-amd added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 13, 2026
@mbenavidez-amd
mbenavidez-amd merged commit 6e89223 into ROCm:develop Jul 13, 2026
4 checks passed
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant