From efcb9ae8ada868a8f246f71051bdd09a7c2dd081 Mon Sep 17 00:00:00 2001 From: Akbar Nurlybayev Date: Wed, 15 Apr 2026 15:01:37 -0600 Subject: [PATCH 01/17] Upgrade mintlify --- AGENTS.md | 16 ++++---- Dockerfile | 10 ++--- README.md | 30 +++++++------- docker-compose.yml | 2 - docs.json | 100 +++++++++++++++++++++++++++++++++++++++++++++ mint.json | 95 ------------------------------------------ 6 files changed, 128 insertions(+), 125 deletions(-) create mode 100644 docs.json delete mode 100644 mint.json diff --git a/AGENTS.md b/AGENTS.md index 996c78d..730fdc6 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -4,7 +4,7 @@ This repository is a Mintlify documentation site for NVIDIA CCluster. Future age ## Quick Orientation -- The docs site is configured by [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json). +- The docs site is configured by [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). - Most content is written as `.mdx` files under [home/](/Users/anurlybayev/Developer/codex/centml_platform_docs/home), [apps/](/Users/anurlybayev/Developer/codex/centml_platform_docs/apps), [clients/](/Users/anurlybayev/Developer/codex/centml_platform_docs/clients), [resources/](/Users/anurlybayev/Developer/codex/centml_platform_docs/resources), and [examples/](/Users/anurlybayev/Developer/codex/centml_platform_docs/examples). - Shared MDX helpers currently live in [snippets/components.mdx](/Users/anurlybayev/Developer/codex/centml_platform_docs/snippets/components.mdx). - Static assets live in [images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images). @@ -12,18 +12,18 @@ This repository is a Mintlify documentation site for NVIDIA CCluster. Future age ## Known Good Local Setup -- Mintlify is pinned to `4.2.28` in the Dockerfile. +- The Dockerfile installs the latest Mintlify CLI with `mint@latest`. - Preferred preview command: ```bash docker compose up --build ``` -- Direct local CLI is acceptable, but keep it on the same version: +- Direct local CLI is acceptable: ```bash -npm install -g mintlify@4.2.28 -mintlify dev +npm install -g mint@latest +mint dev ``` ## Repo Shape @@ -37,7 +37,7 @@ mintlify dev ## Editing Rules Of Thumb -- Treat [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json) as the source of truth for page order and visibility. +- Treat [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json) as the source of truth for page order and visibility. - A file existing on disk does not mean it is published in the nav. - Prefer local image references like `/images/file.png` for assets stored in this repo. - Preserve existing MDX style and frontmatter keys such as `title`, `description`, `icon`, and optional `sidebarTitle` or `mode`. @@ -53,13 +53,13 @@ mintlify dev ## Things That May Surprise You -- The current [README.md](/Users/anurlybayev/Developer/codex/centml_platform_docs/README.md) is repo-specific and should stay aligned with the pinned Mintlify version. +- The current [README.md](/Users/anurlybayev/Developer/codex/centml_platform_docs/README.md) is repo-specific and should stay aligned with the repository’s Mintlify workflow. - The repository contains some content and assets that are not currently referenced from navigation. - There is a local `node_modules/` directory in the working tree environment, but it is not tracked by git and should not be relied on as repository metadata. ## Good First Checks For Any Task -1. Read [README.md](/Users/anurlybayev/Developer/codex/centml_platform_docs/README.md) and [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json). +1. Read [README.md](/Users/anurlybayev/Developer/codex/centml_platform_docs/README.md) and [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). 2. Inspect the target page and any shared snippet it imports. 3. Confirm whether the page is navigation-backed or just present in the repo. 4. Use the Docker preview if anything about Mintlify versioning seems uncertain. diff --git a/Dockerfile b/Dockerfile index a3ac910..79a881a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,12 +4,12 @@ FROM node:20-alpine # Set working directory WORKDIR /app -# Install Mintlify CLI globally -RUN npm install -g mintlify@4.2.28 +# Install the current Mintlify CLI globally +RUN npm install -g mint@latest # Create a user and group with specific UID and GID so kubernetes knows -# it's not a root user -RUN addgroup -g 1001 centml && adduser -D -s /bin/bash -u 1001 -G centml centml +# it's not a root user. Alpine images ship with /bin/sh by default. +RUN addgroup -g 1001 centml && adduser -D -s /bin/sh -u 1001 -G centml centml # Copy all documentation files COPY . . @@ -24,4 +24,4 @@ USER 1001:1001 EXPOSE 3000 # Command to run Mintlify dev server -CMD ["mintlify", "dev"] +CMD ["mint", "dev"] diff --git a/README.md b/README.md index 5bfb655..9576344 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ This repository contains the Mintlify source for the NVIDIA CCluster documentation site. -The current known-good Mintlify version is `4.2.28`. That version is pinned in the [Dockerfile](/Users/anurlybayev/Developer/codex/centml_platform_docs/Dockerfile). If you use Mintlify locally outside Docker, use the same version unless you are intentionally validating an upgrade. +This repository now tracks the latest Mintlify CLI in the [Dockerfile](/Users/anurlybayev/Developer/codex/centml_platform_docs/Dockerfile). The site’s layout, branding, and color palette remain defined in [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). ## Repository Layout -- [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json): site configuration, branding, and left-nav structure +- [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json): site configuration, branding, and left-nav structure - [home/](/Users/anurlybayev/Developer/codex/centml_platform_docs/home): landing pages such as introduction and quickstart - [apps/](/Users/anurlybayev/Developer/codex/centml_platform_docs/apps): deployment product docs - [clients/](/Users/anurlybayev/Developer/codex/centml_platform_docs/clients): SDK and client setup docs @@ -27,7 +27,7 @@ For local development you need: ### Preferred: Docker -The repo already includes a Docker-based workflow that uses the pinned Mintlify version. +The repo already includes a Docker-based workflow that installs the latest Mintlify CLI. ```bash docker compose up --build @@ -38,33 +38,33 @@ Then open [http://localhost:3000](http://localhost:3000). Notes: - The repo is mounted into the container, so local file edits are reflected in the preview. -- The image installs `mintlify@4.2.28` globally. +- The image installs `mint@latest` globally. - Port `3000` is exposed by default. ### Alternative: Run Mintlify locally -If you prefer running the CLI directly, install the same version pinned in Docker: +If you prefer running the CLI directly, install the current Mintlify CLI: ```bash -npm install -g mintlify@4.2.28 +npm install -g mint@latest ``` From the repository root, run: ```bash -mintlify dev +mint dev ``` -If Mintlify reports missing local dependencies, run: +If the CLI reports that it is outdated, run: ```bash -mintlify install +mint update ``` ## Editing Workflow 1. Update or add `.mdx` pages under the appropriate section directory. -2. If a page should appear in the docs navigation, add it to [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json). +2. If a page should appear in the docs navigation, add it to [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). 3. Put screenshots and local images in [images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images) and reference them with `/images/...` paths. 4. Reuse helpers from [snippets/components.mdx](/Users/anurlybayev/Developer/codex/centml_platform_docs/snippets/components.mdx) when a page needs the shared hero card or banner components. 5. Preview locally before opening a PR, especially for image paths, imports, and navigation changes. @@ -77,13 +77,13 @@ If you need admin access to the Mintlify project, follow the internal process re ## Important Notes -- `mint.json` is the source of truth for what appears in the left navigation. +- `docs.json` is the source of truth for what appears in the left navigation. - Not every file in the repository is currently linked from navigation. - There is no app build, unit test, or lint pipeline defined in this repo today; the most important validation is a successful local Mintlify preview. -- Avoid casually upgrading Mintlify beyond `4.2.28` until the preview and deployed site are revalidated. +- After a Mintlify upgrade, recheck the local preview to confirm navigation, layout, and brand colors still render as expected. ## Troubleshooting -- If the preview does not start, make sure you are running the command from the repository root where `mint.json` lives. -- If a page returns `404`, confirm the file exists and that its route is correctly listed in `mint.json` when navigation is expected. -- If local Mintlify behaves differently from Docker, trust the Docker flow first because it is version-pinned in the repo. +- If the preview does not start, make sure you are running the command from the repository root where `docs.json` lives. +- If a page returns `404`, confirm the file exists and that its route is correctly listed in `docs.json` when navigation is expected. +- If local Mintlify behaves differently from Docker, trust the Docker flow first because it is the repository’s default preview path. diff --git a/docker-compose.yml b/docker-compose.yml index 9a0d3ec..6f49dcf 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,3 @@ -version: "3.8" - services: docs: build: . diff --git a/docs.json b/docs.json new file mode 100644 index 0000000..412dcd2 --- /dev/null +++ b/docs.json @@ -0,0 +1,100 @@ +{ + "$schema": "https://mintlify.com/docs.json", + "name": "NVIDIA CCluster", + "theme": "mint", + "layout": "solidSidenav", + "logo": { + "dark": "/images/nvidia_ccluster_dark.svg", + "light": "/images/nvidia_ccluster_light.svg", + "href": "https://www.nvidia.com/" + }, + "favicon": "/favicon.png", + "colors": { + "primary": "#004331", + "light": "#00A87B", + "dark": "#33B995" + }, + "background": { + "color": { + "light": "#FFFFFF", + "dark": "#004331" + } + }, + "navbar": { + "links": [ + { + "label": "Get Support", + "href": "/resources/requesting_support" + } + ], + "primary": { + "type": "button", + "label": "Go to Console", + "href": "https://app.centml.com" + } + }, + "navigation": { + "groups": [ + { + "group": "Getting Started", + "pages": [ + "home/introduction", + "home/quickstart" + ] + }, + { + "group": "Deployments", + "pages": [ + "apps/llm", + "apps/inference", + "apps/compute" + ] + }, + { + "group": "Clients", + "pages": [ + "clients/setup", + "clients/sdk" + ] + }, + { + "group": "Resources", + "pages": [ + "resources/custom_image", + "resources/private", + "resources/json_and_tool", + "resources/requesting_support", + "resources/vault", + "resources/model_integration_lifecycle" + ] + }, + { + "group": "Examples", + "pages": [ + { + "group": "Codex", + "icon": "code", + "pages": [ + "examples/codex", + { + "group": "General Inference", + "icon": "robot", + "pages": [ + "examples/general_inference/flux", + "examples/general_inference/json_schema" + ] + } + ] + } + ] + } + ] + }, + "footer": { + "socials": { + "twitter": "https://twitter.com/nvidia", + "linkedin": "https://www.linkedin.com/company/nvidia/", + "github": "https://github.com/NVIDIA" + } + } +} diff --git a/mint.json b/mint.json deleted file mode 100644 index fa223a6..0000000 --- a/mint.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "$schema": "https://mintlify.com/schema.json", - "name": "NVIDIA CCluster", - "theme": "prism", - "layout": "solidSidenav", - "logo": { - "dark": "/images/nvidia_ccluster_dark.svg", - "light": "/images/nvidia_ccluster_light.svg", - "href": "https://www.nvidia.com/" - }, - "favicon": "/favicon.png", - "colors": { - "primary": "#004331", - "light": "#00A87B", - "dark": "#33B995", - "background": { - "light": "#FFFFFF", - "dark": "#004331" - } - }, - "topbarLinks": [ - { - "name": "Get Support", - "url": "/resources/requesting_support" - } - ], - "topbarCtaButton": { - "name": "Get Started", - "url": "/home/quickstart" - }, - "navigation": [ - { - "group": "", - "pages": [ - "home/introduction", - "home/quickstart" - ] - }, - { - "group": "Deployments", - "pages": [ - "apps/llm", - "apps/inference", - "apps/compute" - ] - }, - { - "group": "Clients", - "pages": [ - "clients/setup", - "clients/sdk" - ] - }, - { - "group": "Resources", - "pages": [ - "resources/custom_image", - "resources/private", - "resources/json_and_tool", - "resources/requesting_support", - "resources/vault", - "resources/model_integration_lifecycle" - ] - }, - { - "group": "Examples", - "pages": [ - - { - "group": "Codex", - "icon": "code", - "pages": [ - "examples/codex", - { - "group": "General Inference", - "icon": "robot", - "pages": [ - "examples/general_inference/flux", - "examples/general_inference/json_schema" - ] - } - - - ] - } - - ] - } - ], - "footerSocials": { - "twitter": "https://twitter.com/nvidia", - "linkedin": "https://www.linkedin.com/company/nvidia/", - "github": "https://github.com/NVIDIA" - } -} From 5ba9ca315f5e6bbb04bdbdc174b4336a858d81b7 Mon Sep 17 00:00:00 2001 From: Akbar Nurlybayev Date: Wed, 15 Apr 2026 15:08:17 -0600 Subject: [PATCH 02/17] Add legal and privacy disclosure to the footer --- docs.json | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/docs.json b/docs.json index 412dcd2..606f7da 100644 --- a/docs.json +++ b/docs.json @@ -91,6 +91,51 @@ ] }, "footer": { + "links": [ + { + "header": "Privacy", + "items": [ + { + "label": "Privacy Policy", + "href": "https://www.nvidia.com/en-us/about-nvidia/privacy-policy/" + }, + { + "label": "Your Privacy Choices", + "href": "https://www.nvidia.com/en-us/about-nvidia/privacy-center/" + } + ] + }, + { + "header": "Legal", + "items": [ + { + "label": "Terms of Service", + "href": "https://www.nvidia.com/en-us/about-nvidia/terms-of-service/" + }, + { + "label": "Accessibility", + "href": "https://www.nvidia.com/en-us/about-nvidia/accessibility/" + }, + { + "label": "Corporate Policies", + "href": "https://www.nvidia.com/en-us/about-nvidia/company-policies/" + } + ] + }, + { + "header": "Support", + "items": [ + { + "label": "Product Security", + "href": "https://www.nvidia.com/en-us/product-security/" + }, + { + "label": "Contact", + "href": "https://www.nvidia.com/en-us/contact/" + } + ] + } + ], "socials": { "twitter": "https://twitter.com/nvidia", "linkedin": "https://www.linkedin.com/company/nvidia/", From fa6f80528c87fe6bace176b6cc928169cf1cf4dd Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 11:21:25 -0400 Subject: [PATCH 03/17] fix(docs): pin mint CLI, drop invalid layout key, restore Get Started CTA MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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 --- AGENTS.md | 34 +++++++++++++++++----------------- Dockerfile | 4 ++-- README.md | 34 +++++++++++++++++----------------- docs.json | 5 ++--- 4 files changed, 38 insertions(+), 39 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 730fdc6..59fbf0f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -4,40 +4,40 @@ This repository is a Mintlify documentation site for NVIDIA CCluster. Future age ## Quick Orientation -- The docs site is configured by [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). -- Most content is written as `.mdx` files under [home/](/Users/anurlybayev/Developer/codex/centml_platform_docs/home), [apps/](/Users/anurlybayev/Developer/codex/centml_platform_docs/apps), [clients/](/Users/anurlybayev/Developer/codex/centml_platform_docs/clients), [resources/](/Users/anurlybayev/Developer/codex/centml_platform_docs/resources), and [examples/](/Users/anurlybayev/Developer/codex/centml_platform_docs/examples). -- Shared MDX helpers currently live in [snippets/components.mdx](/Users/anurlybayev/Developer/codex/centml_platform_docs/snippets/components.mdx). -- Static assets live in [images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images). -- The local preview environment is containerized via [Dockerfile](/Users/anurlybayev/Developer/codex/centml_platform_docs/Dockerfile) and [docker-compose.yml](/Users/anurlybayev/Developer/codex/centml_platform_docs/docker-compose.yml). +- The docs site is configured by [docs.json](docs.json). +- Most content is written as `.mdx` files under [home/](home), [apps/](apps), [clients/](clients), [resources/](resources), and [examples/](examples). +- Shared MDX helpers currently live in [snippets/components.mdx](snippets/components.mdx). +- Static assets live in [images/](images). +- The local preview environment is containerized via [Dockerfile](Dockerfile) and [docker-compose.yml](docker-compose.yml). ## Known Good Local Setup -- The Dockerfile installs the latest Mintlify CLI with `mint@latest`. +- The Dockerfile pins the Mintlify CLI to `mint@4.2.516`. - Preferred preview command: ```bash docker compose up --build ``` -- Direct local CLI is acceptable: +- Direct local CLI is acceptable, but keep it on the same version: ```bash -npm install -g mint@latest +npm install -g mint@4.2.516 mint dev ``` ## Repo Shape -- [home/](/Users/anurlybayev/Developer/codex/centml_platform_docs/home): entry-point pages -- [apps/](/Users/anurlybayev/Developer/codex/centml_platform_docs/apps): product capability pages -- [clients/](/Users/anurlybayev/Developer/codex/centml_platform_docs/clients): SDK/client usage docs -- [resources/](/Users/anurlybayev/Developer/codex/centml_platform_docs/resources): operational and supporting guides -- [examples/](/Users/anurlybayev/Developer/codex/centml_platform_docs/examples): example pages and nested example groups -- [endpoints/](/Users/anurlybayev/Developer/codex/centml_platform_docs/endpoints): API-related files not currently exposed in navigation +- [home/](home): entry-point pages +- [apps/](apps): product capability pages +- [clients/](clients): SDK/client usage docs +- [resources/](resources): operational and supporting guides +- [examples/](examples): example pages and nested example groups +- [endpoints/](endpoints): API-related files not currently exposed in navigation ## Editing Rules Of Thumb -- Treat [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json) as the source of truth for page order and visibility. +- Treat [docs.json](docs.json) as the source of truth for page order and visibility. - A file existing on disk does not mean it is published in the nav. - Prefer local image references like `/images/file.png` for assets stored in this repo. - Preserve existing MDX style and frontmatter keys such as `title`, `description`, `icon`, and optional `sidebarTitle` or `mode`. @@ -53,13 +53,13 @@ mint dev ## Things That May Surprise You -- The current [README.md](/Users/anurlybayev/Developer/codex/centml_platform_docs/README.md) is repo-specific and should stay aligned with the repository’s Mintlify workflow. +- The current [README.md](README.md) is repo-specific and should stay aligned with the repository’s Mintlify workflow. - The repository contains some content and assets that are not currently referenced from navigation. - There is a local `node_modules/` directory in the working tree environment, but it is not tracked by git and should not be relied on as repository metadata. ## Good First Checks For Any Task -1. Read [README.md](/Users/anurlybayev/Developer/codex/centml_platform_docs/README.md) and [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). +1. Read [README.md](README.md) and [docs.json](docs.json). 2. Inspect the target page and any shared snippet it imports. 3. Confirm whether the page is navigation-backed or just present in the repo. 4. Use the Docker preview if anything about Mintlify versioning seems uncertain. diff --git a/Dockerfile b/Dockerfile index 79a881a..b82ba41 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,8 +4,8 @@ FROM node:20-alpine # Set working directory WORKDIR /app -# Install the current Mintlify CLI globally -RUN npm install -g mint@latest +# Install Mintlify CLI (pinned to a verified working version) +RUN npm install -g mint@4.2.516 # Create a user and group with specific UID and GID so kubernetes knows # it's not a root user. Alpine images ship with /bin/sh by default. diff --git a/README.md b/README.md index 9576344..168ce09 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,19 @@ This repository contains the Mintlify source for the NVIDIA CCluster documentation site. -This repository now tracks the latest Mintlify CLI in the [Dockerfile](/Users/anurlybayev/Developer/codex/centml_platform_docs/Dockerfile). The site’s layout, branding, and color palette remain defined in [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). +The Mintlify CLI is pinned to `mint@4.2.516` in the [Dockerfile](Dockerfile). If you use Mintlify locally outside Docker, use the same version unless you are intentionally validating an upgrade. The site's layout, branding, and color palette are defined in [docs.json](docs.json). ## Repository Layout -- [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json): site configuration, branding, and left-nav structure -- [home/](/Users/anurlybayev/Developer/codex/centml_platform_docs/home): landing pages such as introduction and quickstart -- [apps/](/Users/anurlybayev/Developer/codex/centml_platform_docs/apps): deployment product docs -- [clients/](/Users/anurlybayev/Developer/codex/centml_platform_docs/clients): SDK and client setup docs -- [resources/](/Users/anurlybayev/Developer/codex/centml_platform_docs/resources): supporting guides such as pricing, support, vault, and custom images -- [examples/](/Users/anurlybayev/Developer/codex/centml_platform_docs/examples): example-driven docs -- [snippets/components.mdx](/Users/anurlybayev/Developer/codex/centml_platform_docs/snippets/components.mdx): shared custom MDX components used across pages -- [images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images): local static assets referenced by MDX pages -- [endpoints/](/Users/anurlybayev/Developer/codex/centml_platform_docs/endpoints): API-related assets that are present in the repo but are not currently wired into navigation +- [docs.json](docs.json): site configuration, branding, and left-nav structure +- [home/](home): landing pages such as introduction and quickstart +- [apps/](apps): deployment product docs +- [clients/](clients): SDK and client setup docs +- [resources/](resources): supporting guides such as pricing, support, vault, and custom images +- [examples/](examples): example-driven docs +- [snippets/components.mdx](snippets/components.mdx): shared custom MDX components used across pages +- [images/](images): local static assets referenced by MDX pages +- [endpoints/](endpoints): API-related assets that are present in the repo but are not currently wired into navigation ## Prerequisites @@ -27,7 +27,7 @@ For local development you need: ### Preferred: Docker -The repo already includes a Docker-based workflow that installs the latest Mintlify CLI. +The repo already includes a Docker-based workflow that installs the pinned Mintlify CLI version. ```bash docker compose up --build @@ -38,15 +38,15 @@ Then open [http://localhost:3000](http://localhost:3000). Notes: - The repo is mounted into the container, so local file edits are reflected in the preview. -- The image installs `mint@latest` globally. +- The image installs `mint@4.2.516` globally. - Port `3000` is exposed by default. ### Alternative: Run Mintlify locally -If you prefer running the CLI directly, install the current Mintlify CLI: +If you prefer running the CLI directly, install the same version pinned in Docker: ```bash -npm install -g mint@latest +npm install -g mint@4.2.516 ``` From the repository root, run: @@ -64,9 +64,9 @@ mint update ## Editing Workflow 1. Update or add `.mdx` pages under the appropriate section directory. -2. If a page should appear in the docs navigation, add it to [docs.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/docs.json). -3. Put screenshots and local images in [images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images) and reference them with `/images/...` paths. -4. Reuse helpers from [snippets/components.mdx](/Users/anurlybayev/Developer/codex/centml_platform_docs/snippets/components.mdx) when a page needs the shared hero card or banner components. +2. If a page should appear in the docs navigation, add it to [docs.json](docs.json). +3. Put screenshots and local images in [images/](images) and reference them with `/images/...` paths. +4. Reuse helpers from [snippets/components.mdx](snippets/components.mdx) when a page needs the shared hero card or banner components. 5. Preview locally before opening a PR, especially for image paths, imports, and navigation changes. ## How Publishing Works diff --git a/docs.json b/docs.json index 606f7da..83d1608 100644 --- a/docs.json +++ b/docs.json @@ -2,7 +2,6 @@ "$schema": "https://mintlify.com/docs.json", "name": "NVIDIA CCluster", "theme": "mint", - "layout": "solidSidenav", "logo": { "dark": "/images/nvidia_ccluster_dark.svg", "light": "/images/nvidia_ccluster_light.svg", @@ -29,8 +28,8 @@ ], "primary": { "type": "button", - "label": "Go to Console", - "href": "https://app.centml.com" + "label": "Get Started", + "href": "/home/quickstart" } }, "navigation": { From fcdc6cd197ba44f67bfbb5d2e74c697b2f9147d2 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 11:23:40 -0400 Subject: [PATCH 04/17] chore(docs): rename twitter social to x Platform rebranded to X; update social key and URL accordingly. Signed-off-by: Honglin Cao --- docs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.json b/docs.json index 83d1608..dabb0ab 100644 --- a/docs.json +++ b/docs.json @@ -136,7 +136,7 @@ } ], "socials": { - "twitter": "https://twitter.com/nvidia", + "x": "https://x.com/nvidia", "linkedin": "https://www.linkedin.com/company/nvidia/", "github": "https://github.com/NVIDIA" } From 15d53fbccc4e058bee390bbfa8e9a52b03e16489 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 11:38:00 -0400 Subject: [PATCH 05/17] feat(branding): use official NVIDIA logo and eye favicon 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 --- docs.json | 2 +- favicon.svg | 1 + images/nvidia_ccluster_dark.svg | 13 ++++++++++--- images/nvidia_ccluster_light.svg | 13 ++++++++++--- 4 files changed, 22 insertions(+), 7 deletions(-) create mode 100644 favicon.svg diff --git a/docs.json b/docs.json index dabb0ab..3254252 100644 --- a/docs.json +++ b/docs.json @@ -7,7 +7,7 @@ "light": "/images/nvidia_ccluster_light.svg", "href": "https://www.nvidia.com/" }, - "favicon": "/favicon.png", + "favicon": "/favicon.svg", "colors": { "primary": "#004331", "light": "#00A87B", diff --git a/favicon.svg b/favicon.svg new file mode 100644 index 0000000..ae65b09 --- /dev/null +++ b/favicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/nvidia_ccluster_dark.svg b/images/nvidia_ccluster_dark.svg index fa636d5..238c6ae 100644 --- a/images/nvidia_ccluster_dark.svg +++ b/images/nvidia_ccluster_dark.svg @@ -1,4 +1,11 @@ - - - NVIDIA + + + + + + + + + + diff --git a/images/nvidia_ccluster_light.svg b/images/nvidia_ccluster_light.svg index 116ce2c..16c034a 100644 --- a/images/nvidia_ccluster_light.svg +++ b/images/nvidia_ccluster_light.svg @@ -1,4 +1,11 @@ - - - NVIDIA + + + + + + + + + + From f6a72671d92cf5b8967d7a84241f7a6c41752192 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 14:53:29 -0400 Subject: [PATCH 06/17] chore(branding): remove unreferenced favicon.png Superseded by favicon.svg in the previous commit; no longer referenced from docs.json. Signed-off-by: Honglin Cao --- favicon.png | Bin 5106 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 favicon.png diff --git a/favicon.png b/favicon.png deleted file mode 100644 index ff2aa4436022cfc8c6445ab9c7fcc21e7902e395..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5106 zcmV6LgdWyrLpf z^%F~J1tG**%cEWuy`tBu*IMsY6s=+nLJWBk0tAwoIcMFqCwRZAWO9bH=gIkf-^rZG zoH=vOS!?gT_F8-I1-Q7lxVX5uxVRj42xKcOg8d;w!ysrF3^@Xp7y?*+kSO6#2lAHB zckkm@$(zMn7jGTB?c%M8w|f43E5Clu=h%j@wG~tDZ9|rk9SZQmf;=?u9toc~0hT$E z|8oX!EN~3qtuLI@2|_zRtA0rIUXMCL9RZ}<4eoNE-G=CaxF;C#>A?RkOrj3Lw;)3Kp5Ui?v7u@?~0M_2(+>x z`yfKrJ(u49RY6VZ{gd% zh2QybxFVt+$Yl`LohYB*j3kp91z28r47{|0_fCe(SNt!eHHDR6Gm=R1yH+)oQ`ykl z1XuXqEe)gkJ!xet7a6E%XqZzqK0*Mz!?Yv@G9WSu4cM@FeunFWHkMiJNB!R>>0X3D! zu{J-;d&eL>2=N{7V`XH^Tc~|A+WAsXfw(XT@^Sw>m*1-paw=-7cK-dbm|Xojl0@Qe zvS#+tAghKQdMOY-5r>I)v1GTfQ2)ZOA9G{36=B)|uV{wwv?IT;17oI#qHft>P+}-| zMRWG#L-r})?-%p6m#{EOVaSnu%=h_}qxk>*66m39Vy7Y)Ghc2F-H4I_T2{36QzdN6w+#u*g$SO>jI|oTdzXGU% z8lB?zT&13gZQ^5v~uWZY0inj$?Gl3a-8<@HLeoUIe`f@#(*y{Am*@ zK(7MSR4AYREl4E9ZMl^9LKwecOF4vep|;ilz4r^YJ$}v?ImG6-K19TO2CfY5MvBm< z05uiU_-u=!)^s8eVkfu1OCY?9F)8>Z(v@c_h9X2a^Yvbf?$O5wN3fAf>!_N8vU1Kz?Aw2U_s%`Yr+fH*E@$Dth!o>o0amin zCxyC^6QCQ4j?rI$?=&yK$xFh>G-`wSh=iuY5VQGS`W^VM@;yw$r0OL|1DsXY#0s=p z+=E02A6(^2^I}Yx|7T<>-QK+USULL*E+lIX)R2o{e6kd2g0mW6b>)v(3)ZtDIP3;} z1Hwjhh9+U^f*r^fo(YyA9GSq?{sTxO4qXA(1&h!TQeL)U&_%afb`7k~>oNI(7Pusw zLyrdT4c(|;_+lxfx7-ze@;EdFSUG1D3+q!QjT+%B;JSb@-5=80Sr`V42kYU zgs#E3C2q-25%CGKrb11_egn|qK@__o%nLKRpPvQ9>j+ZuYF(wjDiy-d%PaBc<#`9g zu>3@_z!FxDv_zPM*lSv}%kZE@gv0gC&CN*}l9g)gE5I{%1Q6B~<`sAeeLasL3FQ0z zB{{+~MhI~!$U1|6yhN=B1L|)51i#V&l{Tb^E*3+EkBSDD)v|C z@{Gouyt3t{X|8Q+Zcw#W+RW~CioGXN8!Utsew+7>f>VTe028WaB0&rqG^iBboVk2s zSMZPJLocfG_`OMys6RS%kzO29=auDSUn25)e}pAbf>- zUgc7FUgaj@zJh`w`g|cN!kz*MjDZeFEaouiHs~f0=v(A3eUKaU-*8nQ|FEn$5m6@? z{hPN>j1}t68zJaB^I?cZQq20J9GZV+gf1c-9>|UpU#J+21_67H0<5O=MSp2SuFX^nF1^AdO-GiGQD^_FyWUTzV^<&x%Gs8hay)*ah7+WW@l zP|FUy$~&(W1OiWZE%^xF2M5B$=Vn*O`1ba;c4P^$6@bL)4!xcPDQcmKva+&1`@=Mi zyL<5jq&A93*TpR@Eqf3@)ZWnWF29~xe8dqqT4cS{)|NfOSM;m^kIov%PL&Z3V}E;K zM&5@ex*|A-g@3yJZ-~EokXyc^rT$Qa|Bsl>Uw-*3WFb8(K!F^}UBCejqraOm>E1f% zft!7r2Adbe^;TOKB4hUM*pl?6*D{Hot!R%plApEH@&4M3Kfiy-a2D%Xc8}+pV(#7@ zJ6z%SLac7oa5zQaLueu*trPi#{cRmA@KJt__c6HiO3w;F7z*dqLlYA8eY?k6f)>=( z)pf$9S7IrE)5HuBP*__POe9XUd#nt3pNESrdR72IC2+<*cw`gwkRw307L#TRaZ^jn z*0j#jkxs<00c5TfB`|TY~hhOd?2gEP}$!VtS z9Q4U?)|EU!b8~YGDZhdZh~kMBy7a67QaE$ss3q48Z3`+#NQjSZ9Vzgg0fUDPgNrR< zIf5GD3?HONV|z^R+C9=s=9O@J z)3q%oy)!R&J!{nqh>v_pw6JOC?hQr$(y@hwg}sg~955g-v?x$|n=e9dSlu&#g<4+- zVe5(f!Gp6V#eM7$t53X-5c}Yr%)3|FwfqBAJFI6#uq|7ZnJt^4zM%j$5XB2w^%9 zY!+Xgj$$-2e9)CegG)ba*-<|i8BXknclG@pe7nxmw5T-(o|>g~J)Ne8h9~&Ex)Lu4 z#5V&*DbcK=KwvU5oZd?hS*zd}(GP~9JDZr*GH}36{Q4)P299*fUlo=NN!bDwI0#`+&~b6&;mc2d{sVW}_ck~j|zr%?$8n5< z{Q@;}vA?Yo=9#Tc+gEUJqyrg_{kCiM9d~hrFbL;xM9+H>CI%Cl1k&&KpBfR~DH2r9 z^|K#`&OSkSk3Epf4a@h3rl!wz*h6W9eFb=O=5Tm(w(vKc4HxhJ**{}M)49n=23cHO zJeWM5^N5V`QqVbUC-gc_Kt$IQ!aHnNyd1IQnzqJm$|IT;YXW_f_^j7e6@TDwjE7@b z3?wQssap5ifxS{xR1|>M8<4^~C}Nof!VEZW6MILe`Gf*6k`can`H|9*g)C zVCC$y*-g4pOQ(m#E=Y5%n=vG{#4pO4%4b=6x|U|$$^Q6}(XOUTN{GKbH)(!sPkCGv zLW&x!3>Lv9CB&})Q>x$QisNPI;~dD)ueEy#U2Jh^7QKwz#(y;~z$7k#6@C=!f?8%0 zx!C8>6rlXy)l#d=p_l8>5uWST1j*&l`}Agh725(DMhtz8+hB!O<8ikpNEXgIbTyUd zvpu+u&!V@~s^C)u*Wjvo*|pZs<2Uq0LGiU*(=Eq!_c>j?R140$dK0QPK+1=p8zDx+ zD?h;M**a3yqz6w{4oCkY6;pWxeT{{>)=qGW^NUz|`w__VuHn5zjKAN_-NY*N@jQZY z8Jbx<7?e0RRL+lDjb{F8s$7U2%hzIZwT8hq&d{TUHM5TfafwY_(k3oBawaCuwLL#D zEvV&EZ;?urbrHTb{*u~ZTHnKzd;g9UqOTfSSveI3EnyG3j_jfbgQJLI8CRW)5|VmO zC#$$tG(1ybiJPGY!t@CJH)Q_{P(CYVOVI0VhXe;?G2|rCWfh5k1rOK@?CSYRq(?|jOEz#OwK6~|ElzdecHo$qLzgg`qwty6H#{7;Z%64MoVGFXBfRszB?NG2*lmC8{> zDou^&eM}10K^H56{UN$W!6U}-`A73_ouX%O%>VNi_ItRD*b@R&^q$(@i@4F4>1|vukiFHP(?jfW~8kH{7sv|7WeOzuk zS->H_dwy@J1%_4aVelX2(d3Q#CRWfr5mnr)*dBNaNh0yys8zFuK^n{X0iOw%-XSz_ zjWZS#=hb{F)TUh*nge9<&~YT!iwf|3n&+ z8P#lbgpGGPKTcI6I9swV87OxyuoPbJGF%=^>5#A9$gFnuce4i}$8!+}a4uvM;S7G# zMEa&X7w4a=rhur*8Fhe8xj=szOt77Z(>7mkj3r0E4wq Up&>(k5dZ)H07*qoM6N<$f-QTe!vFvP From 6ce4965744cd0b9ceaed6300270f212e9486f3b4 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 15:05:46 -0400 Subject: [PATCH 07/17] fix(layout): release fixed sidebar at the footer boundary MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- script.js | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 script.js diff --git a/script.js b/script.js new file mode 100644 index 0000000..58efedb --- /dev/null +++ b/script.js @@ -0,0 +1,36 @@ +(function () { + let ticking = false; + + function update() { + const sidebar = document.getElementById('sidebar'); + const footer = document.getElementById('footer'); + if (!sidebar || !footer) return; + + const footerTop = footer.getBoundingClientRect().top; + const viewportHeight = window.innerHeight; + const overlap = viewportHeight - footerTop; + + sidebar.style.bottom = overlap > 0 ? overlap + 'px' : ''; + } + + function request() { + if (ticking) return; + ticking = true; + requestAnimationFrame(function () { + ticking = false; + update(); + }); + } + + window.addEventListener('scroll', request, { passive: true }); + window.addEventListener('resize', request); + + if (document.readyState === 'loading') { + document.addEventListener('DOMContentLoaded', update); + } else { + update(); + } + + // Mintlify is a Next.js SPA; re-run on DOM mutations (route navigation). + new MutationObserver(request).observe(document.body, { childList: true }); +})(); From b01731974f2510e7ed73b9936699d25e27332098 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 15:23:35 -0400 Subject: [PATCH 08/17] refactor(docs): lighten footer to 5 mandatory legal links 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 --- docs.json | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/docs.json b/docs.json index 3254252..9728bab 100644 --- a/docs.json +++ b/docs.json @@ -92,7 +92,7 @@ "footer": { "links": [ { - "header": "Privacy", + "header": "Legal", "items": [ { "label": "Privacy Policy", @@ -101,12 +101,7 @@ { "label": "Your Privacy Choices", "href": "https://www.nvidia.com/en-us/about-nvidia/privacy-center/" - } - ] - }, - { - "header": "Legal", - "items": [ + }, { "label": "Terms of Service", "href": "https://www.nvidia.com/en-us/about-nvidia/terms-of-service/" @@ -120,19 +115,6 @@ "href": "https://www.nvidia.com/en-us/about-nvidia/company-policies/" } ] - }, - { - "header": "Support", - "items": [ - { - "label": "Product Security", - "href": "https://www.nvidia.com/en-us/product-security/" - }, - { - "label": "Contact", - "href": "https://www.nvidia.com/en-us/contact/" - } - ] } ], "socials": { From 06afe3d8a311d55b8e6ec8d9e6267d254ea81dff Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 16:09:30 -0400 Subject: [PATCH 09/17] fix(layout): also reset sidebar top so it anchors cleanly to navbar 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 --- script.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/script.js b/script.js index 58efedb..4cd8501 100644 --- a/script.js +++ b/script.js @@ -10,7 +10,13 @@ const viewportHeight = window.innerHeight; const overlap = viewportHeight - footerTop; - sidebar.style.bottom = overlap > 0 ? overlap + 'px' : ''; + // Keep the sidebar anchored to the navbar and only trim its bottom when + // the footer is in view. Mintlify's built-in one-shot handler tries to + // be clever with `top` and leaves a stale negative value that shifts + // the sidebar off-screen — reset it here so the sidebar stays put. + sidebar.style.top = '4rem'; + sidebar.style.bottom = overlap > 0 ? overlap + 'px' : '0'; + sidebar.style.height = 'auto'; } function request() { From 50e5ff96b30adff18ed6c173197d7834e3fbdf65 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 16:24:40 -0400 Subject: [PATCH 10/17] fix(layout): hide sidebar scrollbar gutter 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 --- script.js | 8 +------- style.css | 10 ++++++++++ 2 files changed, 11 insertions(+), 7 deletions(-) create mode 100644 style.css diff --git a/script.js b/script.js index 4cd8501..58efedb 100644 --- a/script.js +++ b/script.js @@ -10,13 +10,7 @@ const viewportHeight = window.innerHeight; const overlap = viewportHeight - footerTop; - // Keep the sidebar anchored to the navbar and only trim its bottom when - // the footer is in view. Mintlify's built-in one-shot handler tries to - // be clever with `top` and leaves a stale negative value that shifts - // the sidebar off-screen — reset it here so the sidebar stays put. - sidebar.style.top = '4rem'; - sidebar.style.bottom = overlap > 0 ? overlap + 'px' : '0'; - sidebar.style.height = 'auto'; + sidebar.style.bottom = overlap > 0 ? overlap + 'px' : ''; } function request() { diff --git a/style.css b/style.css new file mode 100644 index 0000000..ee73f81 --- /dev/null +++ b/style.css @@ -0,0 +1,10 @@ +/* Hide the sidebar's internal scrollbar and reserved gutter so no vertical + "slider" line shows along the sidebar edge. Scrolling still works via + wheel, touch, and keyboard. */ +#sidebar-content { + scrollbar-gutter: auto; + scrollbar-width: none; +} +#sidebar-content::-webkit-scrollbar { + display: none; +} From 1697bac9dda6b990f8807efdad22e611c9e29200 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 17:11:46 -0400 Subject: [PATCH 11/17] fix(layout): move footer into content-area to match Mintlify's layout MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- script.js | 45 ++++++++++++++++++--------------------------- 1 file changed, 18 insertions(+), 27 deletions(-) diff --git a/script.js b/script.js index 58efedb..c3e63a5 100644 --- a/script.js +++ b/script.js @@ -1,36 +1,27 @@ +// Match Mintlify's current-production layout by moving the footer into +// #content-area (the right column). Our pinned version puts the footer in +// a parallel flex column at page level, which causes the fixed left +// sidebar to overlap the footer when scrolled to the bottom. +// +// Mintlify's own docs (mintlify.com/docs) render the footer inside +// #content-area so the sidebar never interacts with it. This script +// reproduces that structure at runtime. (function () { - let ticking = false; - - function update() { - const sidebar = document.getElementById('sidebar'); + function relocate() { const footer = document.getElementById('footer'); - if (!sidebar || !footer) return; - - const footerTop = footer.getBoundingClientRect().top; - const viewportHeight = window.innerHeight; - const overlap = viewportHeight - footerTop; - - sidebar.style.bottom = overlap > 0 ? overlap + 'px' : ''; + const contentArea = document.getElementById('content-area'); + if (!footer || !contentArea) return; + if (contentArea.contains(footer)) return; + contentArea.appendChild(footer); } - function request() { - if (ticking) return; - ticking = true; - requestAnimationFrame(function () { - ticking = false; - update(); - }); - } - - window.addEventListener('scroll', request, { passive: true }); - window.addEventListener('resize', request); - if (document.readyState === 'loading') { - document.addEventListener('DOMContentLoaded', update); + document.addEventListener('DOMContentLoaded', relocate); } else { - update(); + relocate(); } - // Mintlify is a Next.js SPA; re-run on DOM mutations (route navigation). - new MutationObserver(request).observe(document.body, { childList: true }); + // Mintlify is a Next.js SPA; re-apply after route changes or re-renders + // that may reset the DOM. + new MutationObserver(relocate).observe(document.body, { childList: true, subtree: true }); })(); From a228133d6fe2309f3e57ae39b5a691d46678aa55 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Mon, 20 Apr 2026 18:39:49 -0400 Subject: [PATCH 12/17] docs: adhere to Mintlify formatting guide - 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 `` 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 --- apps/compute.mdx | 8 ++++---- apps/inference.mdx | 8 ++++---- apps/llm.mdx | 6 +++--- endpoints/dedicated.mdx | 3 ++- home/concepts.mdx | 2 +- home/quickstart.mdx | 4 ++-- resources/requesting_support.mdx | 8 ++++---- resources/vault.mdx | 22 +++++++++++----------- 8 files changed, 31 insertions(+), 30 deletions(-) diff --git a/apps/compute.mdx b/apps/compute.mdx index de978cb..91fd205 100644 --- a/apps/compute.mdx +++ b/apps/compute.mdx @@ -16,7 +16,7 @@ Spin up a compute instance by choosing one of the available base images: Enter your SSH public key to configure access to the instance, select a GPU instance type, and click Deploy. - + Compute instance launch page ## 2. SSH into the instance @@ -26,7 +26,7 @@ Once the instance is ready, navigate to the deployment details page. The **Endpo - **Endpoint URL** — the hostname for your instance. Next to it are the copy button (copies the URL) and the SSH button (copies `ssh root@` so you can paste it directly into your terminal). - + SSH key configuration for a compute instance To connect, use the SSH command with the `root` user: @@ -36,13 +36,13 @@ ssh root@ ``` - + Running compute instance showing its endpoint URL The instance comes preloaded with the libraries included in your selected base image. For **PyTorch** instances, CUDA libraries are bundled in the NGC image. For **Ubuntu** instances on full GPU hardware, NVIDIA drivers are available; on MIG instances, NVIDIA drivers are not available. Additional packages and libraries can be installed with your preferred package manager. -# What's Next +## What's next - + General Inference deployment page @@ -62,7 +62,7 @@ curl -X POST https:///api/chat -d '{"model": "qwen2:1.5b", "messag By default, NVIDIA CCluster provides several managed clusters and GPU instances for you to deploy your inference containers. - + Hardware instance selection for general inference Select the regional cluster and hardware instance that best fits your need and click Deploy. @@ -76,13 +76,13 @@ You can integrate your own private cluster into CCluster through bring-your-own- Once deployed, you can see all your deployments under the listing view along with their current status. - + Container image configuration for general inference Click on the deployment to view the details page, logs and monitoring information. - + Deployment details panel after launching a general inference endpoint Once the deployment status is ready, the container port is going to be exposed under the endpoint url shown in the details page. diff --git a/apps/llm.mdx b/apps/llm.mdx index fcc7362..0522310 100644 --- a/apps/llm.mdx +++ b/apps/llm.mdx @@ -10,7 +10,7 @@ Deploy dedicated LLM endpoints that fits your performance requirements and budge Select or enter the Hugging Face model name of your choosing and provide your Hugging Face token. Also provide a name for the dedicated endpoint you are going to deploy. - + LLM Serving page showing available models @@ -21,7 +21,7 @@ Make sure you have been granted access to the model you selected. If not, please Choose the cluster or the region you want to deploy the model. Based on that, NVIDIA CCluster presents three pre-configured deployment configurations to suit different requirements: - + LLM Serving deployment configuration options - **Best performance:** A configuration optimized for latency and throughput, suitable for high-demand applications where performance is critical. @@ -70,7 +70,7 @@ For more details on how to use the LLM deployment, please refer to the [examples -# What's Next +## What's next - + Console showing all deployment checks passed ## Troubleshooting diff --git a/home/quickstart.mdx b/home/quickstart.mdx index f092cc5..095aad7 100644 --- a/home/quickstart.mdx +++ b/home/quickstart.mdx @@ -13,13 +13,13 @@ To get started, sign in to the NVIDIA CCluster console using the access details - + NVIDIA CCluster sign-in screen Once logged in, you will see the NVIDIA CCluster console home page, as shown below. - + NVIDIA CCluster console home page diff --git a/resources/requesting_support.mdx b/resources/requesting_support.mdx index f85f449..ac1438f 100644 --- a/resources/requesting_support.mdx +++ b/resources/requesting_support.mdx @@ -18,7 +18,7 @@ To submit a request from the NVIDIA CCluster UI, you must have an active NVIDIA Once logged in, you can submit a request by selecting `Support` located near the bottom of the sidebar menu. - + Support request form with category dropdown @@ -57,7 +57,7 @@ Any requests that don't fit the above catagory. Send it here and we will route i Use the dropdown menu pictured below to select the appropriate priority for your request. The NVIDIA team will triage submissions internally, using the selected `Priority` as a guideline. - + Priority level dropdown in the support request form @@ -122,7 +122,7 @@ As alluded to in our example request ticket above, users can also attach relevan To do so, you can simply must click the box labeled `Click to upload or drag and drop files here`. From there, they can select a file based on its location on your local machine. - + File upload area on the support request form @@ -145,7 +145,7 @@ If your organization has a dedicated NVIDIA support contact or escalation path, Congratulations! You've now know how to submit your first support request! -# What's Next +## What's next diff --git a/resources/vault.mdx b/resources/vault.mdx index fcddd70..b0c4a14 100644 --- a/resources/vault.mdx +++ b/resources/vault.mdx @@ -13,7 +13,7 @@ You will need to log in to the NVIDIA CCluster to manage Vault objects. If you d Once logged in, you will need to select `Account` from sidebar menu, and then click on the `Vault` tab from the `Your Account` window. - + Vault section of the account page @@ -27,19 +27,19 @@ To generate a bearer token, select green `Add Vault Item`. A dropdown menu will - + Add Vault Item menu showing Bearer Tokens option A windows will pop up name `Add Bearer Token to Your Vault`. From there, you can either name and automatically generate a token with the `Generate new Bearer Token` option or you can enter a previous token using the `Use an existing Bearer Token` option. - + Form for adding a new bearer token to the vault Once you either enter your token in the text box or opt into generating your token, click the green `Add to Vault` option and your Bearer Token should appear in your vault. - + Bearer token listed in the vault after creation @@ -50,22 +50,22 @@ NVIDIA CCluster uses client certificates for [mutual TLS (mTLS)](https://www.clo You can generate or add public certificates for mTLS just like you can with Bearer Tokens. Once you generate the certificate, it will appear in the vault. - + Add Vault Item menu showing Certificates option - + Certificate generation form in the vault - + Generated certificate listed in the vault When generated, `Vault Certificates` download a `.pem` file to your local browser. That `.pem` file is named after the generated cert. You can then use that `.pem` file to access one of NVIDIA CCluster's [private endpoints](/resources/private) as long as they are associated with the appropriate certificate and `.pem` pair. - + Browser download prompt for the generated .pem file @@ -115,17 +115,17 @@ Supported registries include Docker Hub, Amazon ECR, Google Artifact Registry, A - + Form for adding an environment variable to the vault - + Environment variable listed in the vault -# What's Next +## What's next Date: Tue, 21 Apr 2026 10:40:30 -0400 Subject: [PATCH 13/17] docs(footer): split legal column into Privacy/Legal/Support with full 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 --- docs.json | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs.json b/docs.json index 9728bab..3254252 100644 --- a/docs.json +++ b/docs.json @@ -92,7 +92,7 @@ "footer": { "links": [ { - "header": "Legal", + "header": "Privacy", "items": [ { "label": "Privacy Policy", @@ -101,7 +101,12 @@ { "label": "Your Privacy Choices", "href": "https://www.nvidia.com/en-us/about-nvidia/privacy-center/" - }, + } + ] + }, + { + "header": "Legal", + "items": [ { "label": "Terms of Service", "href": "https://www.nvidia.com/en-us/about-nvidia/terms-of-service/" @@ -115,6 +120,19 @@ "href": "https://www.nvidia.com/en-us/about-nvidia/company-policies/" } ] + }, + { + "header": "Support", + "items": [ + { + "label": "Product Security", + "href": "https://www.nvidia.com/en-us/product-security/" + }, + { + "label": "Contact", + "href": "https://www.nvidia.com/en-us/contact/" + } + ] } ], "socials": { From d2d3fd257b62e21f98ba8d199b64e86661e9bd3e Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Tue, 21 Apr 2026 10:55:58 -0400 Subject: [PATCH 14/17] chore(docs): remove unreferenced pages from repo - 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 --- endpoints/dedicated.mdx | 5 --- home/concepts.mdx | 99 ----------------------------------------- 2 files changed, 104 deletions(-) delete mode 100644 endpoints/dedicated.mdx delete mode 100644 home/concepts.mdx diff --git a/endpoints/dedicated.mdx b/endpoints/dedicated.mdx deleted file mode 100644 index f8341c0..0000000 --- a/endpoints/dedicated.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'Get models' -description: 'List available models on the NVIDIA CCluster chat completions API.' -openapi: 'GET /v1/chat/completions' ---- \ No newline at end of file diff --git a/home/concepts.mdx b/home/concepts.mdx deleted file mode 100644 index 5ca1d42..0000000 --- a/home/concepts.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: 'Concepts' -description: 'Learn how to preview changes locally' -icon: 'lightbulb' ---- - - - **Prerequisite** You should have installed Node.js (version 18.10.0 or - higher). - - -Step 1. Install Mintlify on your OS: - - - -```bash npm -npm i -g mintlify -``` - -```bash yarn -yarn global add mintlify -``` - - - -Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command: - -```bash -mintlify dev -``` - -The documentation website is now available at `http://localhost:3000`. - -### Custom Ports - -Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333: - -```bash -mintlify dev --port 3333 -``` - -You will see an error like this if you try to run Mintlify in a port that's already taken: - -```md -Error: listen EADDRINUSE: address already in use :::3000 -``` - -## Mintlify Versions - -Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. - - - -```bash npm -npm i -g mintlify@latest -``` - -```bash yarn -yarn global upgrade mintlify -``` - - - -## Deployment - - - Unlimited editors available under the [Startup - Plan](https://mintlify.com/pricing) - - -You should see the following if the deploy successfully went through: - - - Console showing all deployment checks passed - - -## Troubleshooting - -Here's how to solve some common problems when working with the CLI. - - - - Update to Node v18. Run `mintlify install` and try again. - - -Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint` -folder. Then Open the Git Bash in this location and run `git clone -https://github.com/mintlify/mint.git`. - -Repeat step 3. - - - - Try navigating to the root of your device and delete the ~/.mintlify folder. - Then run `mintlify dev` again. - - - -Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line) From e4dcfb14b0ea1f1bac9d29865ff409cbe76fb410 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Tue, 21 Apr 2026 10:59:59 -0400 Subject: [PATCH 15/17] docs(style): standardize headings to sentence case 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 --- clients/sdk.mdx | 2 +- clients/setup.mdx | 2 +- examples/general_inference/flux.mdx | 4 ++-- examples/general_inference/json_schema.mdx | 10 +++++----- home/quickstart.mdx | 8 ++++---- resources/custom_image.mdx | 2 +- resources/json_and_tool.mdx | 10 +++++----- resources/model_integration_lifecycle.mdx | 8 ++++---- resources/private.mdx | 2 +- resources/requesting_support.mdx | 18 +++++++++--------- resources/vault.mdx | 12 ++++++------ 11 files changed, 39 insertions(+), 39 deletions(-) diff --git a/clients/sdk.mdx b/clients/sdk.mdx index 2686540..88ddc09 100644 --- a/clients/sdk.mdx +++ b/clients/sdk.mdx @@ -21,7 +21,7 @@ with get_centml_client() as cclient: For more examples, please refer to https://github.com/CentML/centml-python-client/blob/main/examples/sdk/ -## What's Next +## What's next -## 2. Create a Bearer Token +## 2. Create a bearer token To interact with NVIDIA CCluster endpoints programmatically, you need a Bearer Token. Follow the [Managing Vault Objects](/resources/vault) documentation to generate one. -## 3. Deploy Your First Model +## 3. Deploy your first model Choose the deployment type that fits your use case: - **[LLM Serving](/apps/llm)** — Deploy dedicated public or private LLM endpoints tailored to your performance requirements and budget. - **[General Inference](/apps/inference)** — Deploy custom containerized models on NVIDIA-managed infrastructure. - **[Compute](/apps/compute)** — Provision GPU compute for training, fine-tuning, or batch workloads. -## Additional Support: Billing, Sales, and/or Technical +## Additional support: billing, sales, and/or technical For access, billing, sales, or technical assistance, follow our [Requesting Support](/resources/requesting_support) guide. -## What's Next +## What's next -### 2. Select the Appropriate Catagory +### 2. Select the appropriate category Once you begin submitting your ticket, you will need to select a relevant catagory. @@ -51,7 +51,7 @@ Requests for adding a new region or zone for your workloads. **Other** Any requests that don't fit the above catagory. Send it here and we will route it to the appropriate team. -### 3. Select the Appropriate Priority +### 3. Select the appropriate priority Use the dropdown menu pictured below to select the appropriate priority for your request. The NVIDIA team will triage submissions internally, using the selected `Priority` as a guideline. @@ -72,7 +72,7 @@ For `Urgent` or `High` requests, we recommend using your organization's fastest | Low | Minimal | Minor inconvenience or cosmetic issue | Typo or UI glitch | Added to backlog for future review | -### 4. Fill Out the Support Request Form +### 4. Fill out the support request form Fill out the text box on the `Submit a Request` window. For best results, follow the guidelines below. A good support ticket should include: @@ -89,7 +89,7 @@ A good support ticket should include: * **Screenshots or logs**, if available, to speed up triage. -#### Example Request +#### Example Request > Subject: Unable to Access Private Endpoint Using Downloaded Certificate with httpx > @@ -117,7 +117,7 @@ A good support ticket should include: > > Sample code snippet and logs are attached. -### 5. Attach Any Relevant Code Snippets, Screenshots, or Logs +### 5. Attach any relevant code snippets, screenshots, or logs As alluded to in our example request ticket above, users can also attach relevant documents, images, or other media to help the NVIDIA team gather information and resolve the request faster. To do so, you can simply must click the box labeled `Click to upload or drag and drop files here`. From there, they can select a file based on its location on your local machine. @@ -134,14 +134,14 @@ To compress a file, you can follow some example guides below: [Compress a file on Windows](https://support.microsoft.com/en-us/windows/zip-and-unzip-files-8d28fa72-f2f9-712f-67df-f80cf89fd4e5) [Compress a file on Linux](https://www.freecodecamp.org/news/how-to-compress-files-in-linux-with-tar-command/) -### 6. Submit the Request +### 6. Submit the request Once you've gone through the above steps and processes, you can click the green `Submit` button. You should then see a notification on your screen confirming you submitted the support ticket. You may also receive an email confirmation through your organization's configured support workflow, depending on how your environment is set up. -## Direct Support Escalation +## Direct support escalation If your organization has a dedicated NVIDIA support contact or escalation path, include the same information described above when escalating directly. These best practices help the support team triage and respond quickly. -## You've done it! +## You've done it! Congratulations! You've now know how to submit your first support request! diff --git a/resources/vault.mdx b/resources/vault.mdx index b0c4a14..b0d27f2 100644 --- a/resources/vault.mdx +++ b/resources/vault.mdx @@ -7,7 +7,7 @@ icon: 'key-skeleton-left-right' The NVIDIA CCluster allows you to generate and manage `Vault` objects such as `Bearer Tokens`, `Certificates`, `Registry Credentials`, `Environment Variables`, `Hugging Face Tokens`, and `SSH Keys`. This guide will walk you through creating `Bearer Tokens` and other Vault objects you can use to configure or access NVIDIA CCluster services. -## Step 1: Login to the NVIDIA CCluster +## Step 1: Log in to the NVIDIA CCluster You will need to log in to the NVIDIA CCluster to manage Vault objects. If you do not yet have access, contact your NVIDIA representative or your organization's designated support contact before proceeding. Once logged in, you will need to select `Account` from sidebar menu, and then click on the `Vault` tab from the `Your Account` window. @@ -19,7 +19,7 @@ Once logged in, you will need to select `Account` from sidebar menu, and then cl Once completed, move onto the second step below based on the type of Vault objects you are creating. -## Step 2A: Creating Bearer Tokens +## Step 2A: Creating bearer tokens Bearer tokens can be used to access NVIDIA CCluster services. @@ -45,7 +45,7 @@ Once you either enter your token in the text box or opt into generating your tok -## Step 2B: Adding Certificates to Your Vault +## Step 2B: Adding certificates to your vault NVIDIA CCluster uses client certificates for [mutual TLS (mTLS)](https://www.cloudflare.com/learning/access-management/what-is-mutual-tls/) You can generate or add public certificates for mTLS just like you can with Bearer Tokens. Once you generate the certificate, it will appear in the vault. @@ -97,12 +97,12 @@ curl -X POST 'https://centml-private-2.fe178792.c-09.centml.com/openai/v1/chat/c ``` -### Adding Your Own Certificates +### Adding your own certificates This section is currently under construction as we work to improve the UX around adding certificates to endpoints on the NVIDIA CCluster. Please check back soon! -## Step 2C: Adding Registry Credentials +## Step 2C: Adding registry credentials Registry credentials allow the NVIDIA CCluster to pull container images from private registries when creating [General Inference](/apps/inference) deployments. @@ -111,7 +111,7 @@ To add registry credentials, select the green `Add Vault Item` button and choose Supported registries include Docker Hub, Amazon ECR, Google Artifact Registry, Azure Container Registry, and any Docker-compatible private registry. CCluster automatically detects the registry from the image URL at deployment time. -## Step 2D: Adding Environment Variables +## Step 2D: Adding environment variables From 5dd2db4e4da0380f34098534c169496bc6eb4d0b Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Tue, 21 Apr 2026 11:03:26 -0400 Subject: [PATCH 16/17] docs(style): trim "What's next" card groups to 3 cards per Mintlify playbook Reduces end-of-page cognitive load. Every card still has a sidebar entry so nothing becomes unreachable. Signed-off-by: Honglin Cao --- apps/compute.mdx | 24 ++++----------- apps/inference.mdx | 34 +++++++-------------- apps/llm.mdx | 16 +--------- clients/sdk.mdx | 18 ++---------- clients/setup.mdx | 24 ++++----------- home/quickstart.mdx | 30 +++++-------------- resources/custom_image.mdx | 36 +++++++---------------- resources/json_and_tool.mdx | 16 +--------- resources/model_integration_lifecycle.mdx | 24 ++++----------- resources/private.mdx | 16 +--------- resources/requesting_support.mdx | 16 +--------- resources/vault.mdx | 24 ++++----------- 12 files changed, 55 insertions(+), 223 deletions(-) diff --git a/apps/compute.mdx b/apps/compute.mdx index 91fd205..1645da7 100644 --- a/apps/compute.mdx +++ b/apps/compute.mdx @@ -44,14 +44,7 @@ The instance comes preloaded with the libraries included in your selected base i ## What's next - - - Explore dedicated public and private endpoints for production model deployments. - + - Submit a Support Request. + Explore dedicated public and private endpoints for production model deployments. - - Learn how agents can interact with NVIDIA CCluster services. - diff --git a/apps/inference.mdx b/apps/inference.mdx index 6e4cc9c..0fcf758 100644 --- a/apps/inference.mdx +++ b/apps/inference.mdx @@ -112,15 +112,15 @@ grpcurl -d '{"prompt": "Hello"}' my-deployment.some-hash.cluster-alias.centml.co -# What's Next +## What's next - + - Explore dedicated public and private endpoints for production model deployments. +Learn how to create private inference endpoints -Learn how to create private inference endpoints - - - Submit a Support Request. + Explore dedicated public and private endpoints for production model deployments. - - Learn how agents can interact with NVIDIA CCluster services. - diff --git a/apps/llm.mdx b/apps/llm.mdx index 0522310..70da9a5 100644 --- a/apps/llm.mdx +++ b/apps/llm.mdx @@ -72,14 +72,7 @@ For more details on how to use the LLM deployment, please refer to the [examples ## What's next - - - Dive into how NVIDIA CCluster can help optimize your Model Integration Lifecycle (MILC). - + Learn how to create private inference endpoints - - - Submit a Support Request. + Learn how to interact with the NVIDIA CCluster programmatically - Submit a Support Request - - Get started with the NVIDIA CCluster in minutes. - - - Dive into how NVIDIA CCluster can help optimize your Model Integration Lifecycle (MILC). - diff --git a/clients/setup.mdx b/clients/setup.mdx index 668170e..3fc30fb 100644 --- a/clients/setup.mdx +++ b/clients/setup.mdx @@ -54,7 +54,7 @@ centml logout ## What's next - + Learn how to generate and store NVIDIA CCluster tokens and other vault objects. - - Learn how to interact with the NVIDIA CCluster programmatically - - - Submit a Support Request - - Dive into how NVIDIA CCluster can help optimize your Model Integration Lifecycle (MILC). + Submit a Support Request diff --git a/home/quickstart.mdx b/home/quickstart.mdx index 8c03cd8..339ae7b 100644 --- a/home/quickstart.mdx +++ b/home/quickstart.mdx @@ -41,28 +41,7 @@ For access, billing, sales, or technical assistance, follow our [Requesting Supp ## What's next - - - Learn how agents can interact with NVIDIA CCluster services. - - - Learn how to interact with the NVIDIA CCluster programmatically - - - Submit a Support Request - + Learn how to build your own containerized inference engines and deploy them on the NVIDIA CCluster. + + Learn how to interact with the NVIDIA CCluster programmatically + diff --git a/resources/custom_image.mdx b/resources/custom_image.mdx index 11839b1..f15c1f2 100644 --- a/resources/custom_image.mdx +++ b/resources/custom_image.mdx @@ -28,14 +28,14 @@ For **private images**, you will need to provide registry credentials so CCluste ## What's next - + - Learn how agents can interact with NVIDIA CCluster services. - + Explore dedicated public and private endpoints for production model and model infrastructure management. + Learn how to interact with CCluster programmatically - - Submit a Support Request - - Get started with the NVIDIA CCluster in minutes. - - - Explore dedicated public and private endpoints for production model and model infrastructure management. - + Learn how agents can interact with NVIDIA CCluster services. + diff --git a/resources/json_and_tool.mdx b/resources/json_and_tool.mdx index 4c2394c..fabb021 100644 --- a/resources/json_and_tool.mdx +++ b/resources/json_and_tool.mdx @@ -324,7 +324,7 @@ Using JSON schema enforcement and function calling (tools) with NVIDIA CCluster For more details, continue exploring this documentation set or use your established NVIDIA support channel if you have questions. - + How to interact with CCluster programmatically - - Get started with the NVIDIA CCluster in minutes. - - - Submit a Support Request - + Explore dedicated public and private endpoints for production model deployments. - - Learn how to interact with the NVIDIA CCluster programmatically. - - Submit a support request. - - - Learn how agents can interact with NVIDIA CCluster services. + Learn how to interact with the NVIDIA CCluster programmatically. diff --git a/resources/private.mdx b/resources/private.mdx index ca65589..07ee489 100644 --- a/resources/private.mdx +++ b/resources/private.mdx @@ -59,7 +59,7 @@ client = OpenAI( ## What's next - + Learn how to interact with the NVIDIA CCluster programmatically - - Submit a Support Request - Learn how to access the NVIDIA CCluster using Python. - - Dive into how NVIDIA CCluster can help optimize your Model Integration Lifecycle (MILC). - diff --git a/resources/requesting_support.mdx b/resources/requesting_support.mdx index d296b05..77c0f39 100644 --- a/resources/requesting_support.mdx +++ b/resources/requesting_support.mdx @@ -148,7 +148,7 @@ Congratulations! You've now know how to submit your first support request! ## What's next - + Learn how to interact with the NVIDIA CCluster programmatically - -Learn how to build your own containerized inference engines and deploy them on the NVIDIA CCluster. - Learn about how you can configure private endpoints on the NVIDIA CCluster. - - Learn how agents can interact with NVIDIA CCluster services. - diff --git a/resources/vault.mdx b/resources/vault.mdx index b0d27f2..17ba970 100644 --- a/resources/vault.mdx +++ b/resources/vault.mdx @@ -127,7 +127,7 @@ Supported registries include Docker Hub, Amazon ECR, Google Artifact Registry, A ## What's next - + Explore dedicated public and private endpoints for production model deployments. - - Learn how to interact with the NVIDIA CCluster programmatically - - Submit a Support Request. - - - Learn how agents can interact with NVIDIA CCluster services. + Learn how to interact with the NVIDIA CCluster programmatically From 18caa4ea1784e4445fb02b82a3dbe04f184ee244 Mon Sep 17 00:00:00 2001 From: Honglin Cao Date: Tue, 21 Apr 2026 11:04:13 -0400 Subject: [PATCH 17/17] docs(support): fix typos and tighten prose in support request guide - 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 --- resources/requesting_support.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/resources/requesting_support.mdx b/resources/requesting_support.mdx index 77c0f39..77713d8 100644 --- a/resources/requesting_support.mdx +++ b/resources/requesting_support.mdx @@ -24,9 +24,9 @@ Once logged in, you can submit a request by selecting `Support` located near the ### 2. Select the appropriate category -Once you begin submitting your ticket, you will need to select a relevant catagory. +Once you begin submitting your ticket, you will need to select a relevant category. -As show above, you can select a catagory from the drop down menu on the `Submit a Request` window. +As shown above, you can select a category from the drop down menu on the `Submit a Request` window. The category definitions and types of inquiries are as follows: @@ -49,7 +49,7 @@ Questions on how we user your data as well as account deletion requests. Requests for adding a new region or zone for your workloads. **Other** -Any requests that don't fit the above catagory. Send it here and we will route it to the appropriate team. +Any requests that don't fit the above category. Send it here and we will route it to the appropriate team. ### 3. Select the appropriate priority @@ -119,7 +119,7 @@ A good support ticket should include: ### 5. Attach any relevant code snippets, screenshots, or logs As alluded to in our example request ticket above, users can also attach relevant documents, images, or other media to help the NVIDIA team gather information and resolve the request faster. -To do so, you can simply must click the box labeled `Click to upload or drag and drop files here`. From there, they can select a file based on its location on your local machine. +To do so, click the box labeled `Click to upload or drag and drop files here`. From there, you can select a file based on its location on your local machine. File upload area on the support request form @@ -142,7 +142,7 @@ You may also receive an email confirmation through your organization's configure If your organization has a dedicated NVIDIA support contact or escalation path, include the same information described above when escalating directly. These best practices help the support team triage and respond quickly. ## You've done it! -Congratulations! You've now know how to submit your first support request! +Congratulations! You now know how to submit your first support request! ## What's next