Skip to content

Adopt instinct-design flavor: Instinct Design System landing-page redesign - #133

Draft
AMD-melliott wants to merge 1 commit into
ROCm:developfrom
AMD-melliott:mat49-redesign
Draft

Adopt instinct-design flavor: Instinct Design System landing-page redesign#133
AMD-melliott wants to merge 1 commit into
ROCm:developfrom
AMD-melliott:mat49-redesign

Conversation

@AMD-melliott

Copy link
Copy Markdown
Collaborator

Motivation

Cut over instinct-docs to the official instinct-design flavor shipped by rocm-docs-core, and redesign the landing page and System Administrators subpages around a shared, reusable icon-card component. This replaces the earlier manual asset port and the older sphinx-design grid-item-card/photography-based cards with something more consistent and easier to maintain.

Technical Details

  • Adopt flavor: "instinct-design" (superseding the manually-vendored design-system assets from the original port).
  • Introduce system-admin/_cards/*.md — reusable MyST {include} partials, one per tool/resource card — used across the landing page and all System Administrators subpages (bare-metal, cluster, co-tools, cloud, virtualization) instead of duplicating card markup per page.
  • Add a collapsible primary sidebar with a working toggle, a sticky on-page rail, and default-open System Administrator groups.
  • Fix the dead docs/_static/css/index.css static-asset reference in conf.py's setup() (the real index.css was already loading correctly via html_css_files; the add_css_file call pointed at a path that never existed).
  • Consolidate the separately-added docs/resources/{index,common-reference}.md pages into the redesign's existing landing-page sections, since their content (Enterprise AI, Omnistat, CVS, AMD SMI, RVS, Instinct Micro-architecture, HIP C++, OpenMP, etc.) was fully duplicated there.
  • Pick up rocm_docs_generate_llms and the new repository_url/use_repository_button/use_issues_button/use_download_button theme options already on develop.
  • Ported forward content added to develop since this branch diverged — Spur, MI3XX Reference Design, AMD-DriveNets System Reference Architecture, and a RoCE traffic-analysis blog card — into the new icon-card format so nothing added upstream in the interim was lost.

Test Plan

  • Confirm the ReadTheDocs dev build for this PR succeeds with no Sphinx warnings/errors.
  • Spot-check the landing page, System Administrators subpages, dark/light toggle, and sidebar toggle behavior.
  • Confirm no dangling references to the removed docs/resources/* pages.

Submission Checklist

Squashed redesign work developed on amd-tme/instinct-docs, merged forward
onto current develop (includes the gpu-arch removal and Spur addition
already on develop).

- Cut over to the official instinct-design flavor from rocm-docs-core
  (superseding the earlier manual asset port).
- Redesign the landing page and System Administrators subpages
  (bare-metal, cluster, co-tools, cloud, virtualization) around a shared
  icon-card component (`system-admin/_cards/*.md` MyST includes), replacing
  the old sphinx-design grid-item-card/img-top photography.
- Add a collapsible primary sidebar with a working toggle, a sticky
  on-page rail, and default-open System Administrator groups.
- Fix the dead `css/index.css` static-asset reference in conf.py's setup().
- Consolidate the separately-added Resources pages (Tools /
  Common Reference) into the redesign's existing landing-page sections,
  since their content was fully duplicated there.
- Port forward new content added to develop in the interim (Spur, MI3XX
  Reference Design, AMD-DriveNets System Reference Architecture, a RoCE
  traffic-analysis blog card) into the new icon-card format.
- Add "Slurm" to the spellcheck wordlist.
- Add ROCm open-source compliance files: a dual MIT/CC BY 4.0 LICENSE.txt
  (adapted from rocm-docs-core, with the CC BY 4.0 carve-out scoped to
  docs/images, docs/system-admin/images, and docs/isv-apps/images), a
  minimal SECURITY.md pointing to GitHub private vulnerability reporting
  and AMD PSIRT, and a docs-focused CONTRIBUTING.md covering the Sphinx
  build and lint/spellcheck checks.
- Point Industries/Verticals to the now-live gsid-verticals-docs project
  (https://instinct.docs.amd.com/projects/gsid-verticals-docs/en/latest/),
  completing a migration the redesign had already stubbed out with a
  placeholder GitHub link:
  - Swap the placeholder nav link (toc + index.md rail) for the real URL.
  - Remove the local vision/, data-science/, life-science/, finance/,
    isv-apps/, and simulation/ page trees now that the content lives in
    gsid-verticals-docs.
  - Add redirects for every old docname so existing bookmarks/inbound
    links land on the new project instead of 404ing. MONAI, DevitoPRO,
    and GSplat were dropped or never migrated, so those three fall back
    to the nearest index page rather than a dead link.
  - Fix a stale LICENSE.txt reference to the now-removed
    docs/isv-apps/images path.
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.

1 participant