Mintlify v4 migration with NVIDIA branding, legal footer, and layout fixes#35
Open
anurlybayev wants to merge 17 commits intomainfrom
Open
Mintlify v4 migration with NVIDIA branding, legal footer, and layout fixes#35anurlybayev wants to merge 17 commits intomainfrom
anurlybayev wants to merge 17 commits intomainfrom
Conversation
This was referenced Apr 15, 2026
V2arK
reviewed
Apr 16, 2026
Contributor
V2arK
left a comment
V2arK
left a comment
There was a problem hiding this comment.
LGTM with the following comments. Please verify if they are intential and I will approve it
Contributor
Author
|
@V2arK can you take over this PR please? I am off for the next 10 days, this might become stale. |
Contributor
|
Understand I will take it over from here. There's already an issue tracking this on platform and I will proceed with a plan of attack tomorrow to get it adhering NVIDIA standard. |
… CTA - Pin mint CLI to 4.2.516 (verified working) instead of @latest for reproducible builds - Drop layout: "solidSidenav" — not a valid docs.json schema key, silently ignored - Restore CTA to "Get Started" -> /home/quickstart (matches merged PR #31; avoids reintroducing external CentML URL flagged in domain conformance audit) - Convert absolute local paths in README.md and AGENTS.md to repo-relative Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Platform rebranded to X; update social key and URL accordingly. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Replace placeholder text-only SVGs with the official NVIDIA eye + wordmark artwork (sourced from platform-ui/src/components/NvidiaLogo). Two variants: - images/nvidia_ccluster_light.svg: black wordmark for light backgrounds - images/nvidia_ccluster_dark.svg: white wordmark for dark backgrounds Both share the NVIDIA Green (#76B900) eye mark. Also replace favicon.png with favicon.svg (the eye symbol, sourced from platform-ui/public/nv.svg) for crisp scaling at any resolution. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Superseded by favicon.svg in the previous commit; no longer referenced from docs.json. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Mintlify's default mint theme pins the left sidebar with position:fixed bottom:0 top:4rem, so it always overlaps the footer when scrolled to the page bottom — the footer looks like it only occupies the right half of the page. Add a small inline script (Mintlify auto-injects script.js at repo root) that watches scroll/resize and sets sidebar.style.bottom to the footer's intrusion into the viewport, so the sidebar cleanly stops at the footer boundary and the footer spans full width. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Per the NVIDIA domain conformance policy (Bill Lee guidelines): - Privacy Policy, Terms of Service, Accessibility, Corporate Policies are required for all NVIDIA-owned web properties - Your Privacy Choices is required for sites serving US audiences Drop the two optional links for this docs site: - Product Security: only required for sites carrying hardware announcements; CCluster docs are software-focused - Contact: we have our own support workflow at /resources/requesting_support Collapse from 3 columns (Privacy/Legal/Support) to a single Legal column. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Mintlify's built-in one-shot sidebar handler computes a negative top value (e.g., -548px) that shifts the sidebar off-screen and relies on internal scroll of #sidebar-content to bring items into view. After we trim the bottom at the footer boundary, the stale negative top leaves the sidebar looking detached. Keep top pinned to 4rem (matching the baseline CSS from Mintlify), set bottom to cover the footer overlap, and use height:auto so the sidebar flexes to the available space between navbar and footer. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
The fixed sidebar uses Mintlify's default `stable-scrollbar-gutter` and `overflow-auto` on #sidebar-content, which produces a permanent thin vertical line along the sidebar's right edge. When the sidebar is tall enough to overflow, the actual scrollbar also becomes visually distracting next to the footer. Add style.css to disable the scrollbar gutter and hide the scrollbar itself (Firefox + Chromium/WebKit). Scrolling via wheel, touch, and keyboard still works. Also simplify script.js back to only adjusting the sidebar's bottom so Mintlify's built-in height/top logic continues to flex the sidebar normally. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Mintlify's current production docs (mintlify.com/docs) render the footer inside #content-area — the right column that sits alongside the sidebar. Our pinned Mintlify version (4.2.516) places the footer in a parallel flex column at page level, which causes the fixed left sidebar to overlap the footer's left portion when scrolled to the bottom. Replace the previous sidebar-bottom adjustment with a DOM relocation that appends #footer into #content-area on load and after SPA route changes. This mirrors Mintlify's intended structure without fighting their built-in sidebar positioning. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
- Demote "# What's Next" (H1) in body to "## What's next" (H2, sentence case) on compute, llm, vault, requesting_support. Guide rule: one H1 per page, provided by frontmatter title. - Add descriptive `alt` text to every `<img>` in Frame components across home, apps, resources. Guide rule: every image needs descriptive alt text for accessibility (WCAG 2.1/2.2). - Add missing `description` frontmatter to endpoints/dedicated.mdx so SEO metadata and sidebar subtitle render correctly. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
… NVIDIA link set Add Product Security and Contact to the footer and reorganize into three semantic columns matching NVIDIA's domain conformance recommendations: - Privacy: Privacy Policy, Your Privacy Choices - Legal: Terms of Service, Accessibility, Corporate Policies - Support: Product Security, Contact Previous single-column layout was missing two recommended links (Product Security, Contact) and grouped privacy items under Legal. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
V2arK
changed the title
- home/concepts.mdx was never wired into navigation and carries a stray H1 violating the one-H1-per-page rule. - endpoints/dedicated.mdx is a single hand-written OpenAPI reference that nothing links to. Future API reference should come from the OpenAPI spec in docs.json. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Per MINTLIFY_guide.md: pick one case style and enforce it. Sentence case is the recommended default; product names and acronyms keep their canonical capitalization. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
…laybook Reduces end-of-page cognitive load. Every card still has a sidebar entry so nothing becomes unreachable. Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
- catagory -> category (multiple occurrences) - "You've now know" -> "You now know" - "As show above" -> "As shown above" - Remove redundant "can simply must" phrasing - Strip trailing whitespace on touched lines Signed-off-by: Honglin Cao <Caohonglin317@hotmail.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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes: https://github.com/CentML/platform/issues/3577
Supersedes: #29, #32, #33
Brings the docs site into conformance with NVIDIA's Domain Conformance Policy and Mintlify's v4 configuration format in a single PR. The branding cleanup was already merged via #31; this PR layers on top of that.
What changed
Infrastructure
mint.json→docs.json(Mintlify v4 schema)mintlifyCLI →mintCLI in Dockerfile and docsmintto a verified working version (4.2.516) instead of@latest/bin/sh(the image doesn't shipbash)version: "3.8"key fromdocker-compose.ymllayout: "solidSidenav"from config (not a valid docs.json key; verified against the official JSON schema)NVIDIA branding
platform-ui/src/components/NvidiaLogo), light and dark variantsfavicon.pngwithfavicon.svg(eye symbol fromplatform-ui/public/nv.svg)favicon.pngGet Started → /home/quickstart(matches PR CentML branding cleanup #31, avoids reintroducingapp.centml.comflagged by the conformance audit)footerSocials.twitter→footerSocials.xwithx.com/nvidiaURLLegal footer (NVIDIA Domain Conformance)
Added a three-column footer via native
footer.linkscovering the full NVIDIA required link set:Layout fixes (sidebar vs footer)
Mintlify's default mint theme pins
#sidebarwithposition: fixedand puts#footerin a parallel flex column. Scrolling to the bottom makes the footer appear only on the right because the sidebar covers the left.Mintlify's own production docs (
mintlify.com/docs) avoid this by rendering the footer inside#content-area.script.jsnow relocates#footerinto#content-areaon load and SPA navigation, matching that layout. Also addedstyle.cssto hide thestable-scrollbar-gutterline on the sidebar.Formatting compliance (Mintlify playbook)
# What's Next(H1) to## What's nextoncompute.mdx,llm.mdx,vault.mdx,requesting_support.mdx. One H1 per page — supplied by frontmattertitle.alttext to every<img>(WCAG 2.1/2.2 requirement)descriptionfrontmatter toendpoints/dedicated.mdxRepo hygiene
/Users/anurlybayev/...) inAGENTS.mdandREADME.mdto repo-relative pathsScreenshots
Deferred to follow-ups
Not included in this PR (tracked separately):
CardGroups to 3 cards per Mintlify playbook guidance## 1.,## 2.) to<Steps>components where appropriatehome/concepts.mdx,endpoints/dedicated.mdx) that aren't wired into navigationrobots.txtat repo root with NVIDIA's AI-bot directives (requires canonical list from web governance)