You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit a64c1b9
Browse filesBrowse the repository at this point in the historyBrowse files
Mintlify v4 migration with NVIDIA branding, legal footer, and layout fixes (#35)
Signed-off-by: Honglin Cao <Caohonglin317@hotmail.com>
Signed-off-by: Honglin Cao <hocao@nvidia.com>
Co-authored-by: Honglin Cao <Caohonglin317@hotmail.com>
Co-authored-by: Honglin Cao <hocao@nvidia.com>
Copy file name to clipboardExpand all lines: AGENTS.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@ This repository is a Mintlify documentation site for NVIDIA CCluster. Future age
4
4
5
5
## Quick Orientation
6
6
7
-
- The docs site is configured by [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json).
8
-
- 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).
9
-
- Shared MDX helpers currently live in [snippets/components.mdx](/Users/anurlybayev/Developer/codex/centml_platform_docs/snippets/components.mdx).
10
-
- Static assets live in [images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images).
11
-
- 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).
7
+
- The docs site is configured by [docs.json](docs.json).
8
+
- Most content is written as `.mdx` files under [home/](home), [apps/](apps), [clients/](clients), [resources/](resources), and [examples/](examples).
9
+
- Shared MDX helpers currently live in [snippets/components.mdx](snippets/components.mdx).
10
+
- Static assets live in [images/](images).
11
+
- The local preview environment is containerized via [Dockerfile](Dockerfile) and [docker-compose.yml](docker-compose.yml).
12
12
13
13
## Known Good Local Setup
14
14
15
-
-Mintlify is pinned to `4.2.28` in the Dockerfile.
15
+
-The Dockerfile pins the Mintlify CLI to `mint@4.2.516`.
16
16
- Preferred preview command:
17
17
18
18
```bash
@@ -22,22 +22,22 @@ docker compose up --build
22
22
- Direct local CLI is acceptable, but keep it on the same version:
-[resources/](/Users/anurlybayev/Developer/codex/centml_platform_docs/resources): operational and supporting guides
35
-
-[examples/](/Users/anurlybayev/Developer/codex/centml_platform_docs/examples): example pages and nested example groups
36
-
-[endpoints/](/Users/anurlybayev/Developer/codex/centml_platform_docs/endpoints): API-related files not currently exposed in navigation
31
+
-[home/](home): entry-point pages
32
+
-[apps/](apps): product capability pages
33
+
-[clients/](clients): SDK/client usage docs
34
+
-[resources/](resources): operational and supporting guides
35
+
-[examples/](examples): example pages and nested example groups
36
+
-[endpoints/](endpoints): API-related files not currently exposed in navigation
37
37
38
38
## Editing Rules Of Thumb
39
39
40
-
- Treat [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json) as the source of truth for page order and visibility.
40
+
- Treat [docs.json](docs.json) as the source of truth for page order and visibility.
41
41
- A file existing on disk does not mean it is published in the nav.
42
42
- Prefer local image references like `/images/file.png` for assets stored in this repo.
43
43
- Preserve existing MDX style and frontmatter keys such as `title`, `description`, `icon`, and optional `sidebarTitle` or `mode`.
@@ -53,13 +53,13 @@ mintlify dev
53
53
54
54
## Things That May Surprise You
55
55
56
-
- 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.
56
+
- The current [README.md](README.md) is repo-specific and should stay aligned with the repository’s Mintlify workflow.
57
57
- The repository contains some content and assets that are not currently referenced from navigation.
58
58
- 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.
59
59
60
60
## Good First Checks For Any Task
61
61
62
-
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).
62
+
1. Read [README.md](README.md) and [docs.json](docs.json).
63
63
2. Inspect the target page and any shared snippet it imports.
64
64
3. Confirm whether the page is navigation-backed or just present in the repo.
65
65
4. Use the Docker preview if anything about Mintlify versioning seems uncertain.
Copy file name to clipboardExpand all lines: README.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,19 @@
2
2
3
3
This repository contains the Mintlify source for the NVIDIA CCluster documentation site.
4
4
5
-
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.
5
+
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).
6
6
7
7
## Repository Layout
8
8
9
-
-[mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json): site configuration, branding, and left-nav structure
10
-
-[home/](/Users/anurlybayev/Developer/codex/centml_platform_docs/home): landing pages such as introduction and quickstart
-[snippets/components.mdx](/Users/anurlybayev/Developer/codex/centml_platform_docs/snippets/components.mdx): shared custom MDX components used across pages
16
-
-[images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images): local static assets referenced by MDX pages
17
-
-[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
9
+
-[docs.json](docs.json): site configuration, branding, and left-nav structure
10
+
-[home/](home): landing pages such as introduction and quickstart
11
+
-[apps/](apps): deployment product docs
12
+
-[clients/](clients): SDK and client setup docs
13
+
-[resources/](resources): supporting guides such as pricing, support, vault, and custom images
14
+
-[examples/](examples): example-driven docs
15
+
-[snippets/components.mdx](snippets/components.mdx): shared custom MDX components used across pages
16
+
-[images/](images): local static assets referenced by MDX pages
17
+
-[endpoints/](endpoints): API-related assets that are present in the repo but are not currently wired into navigation
18
18
19
19
## Prerequisites
20
20
@@ -27,7 +27,7 @@ For local development you need:
27
27
28
28
### Preferred: Docker
29
29
30
-
The repo already includes a Docker-based workflow that uses the pinned Mintlify version.
30
+
The repo already includes a Docker-based workflow that installs the pinned Mintlify CLI version.
31
31
32
32
```bash
33
33
docker compose up --build
@@ -38,35 +38,35 @@ Then open [http://localhost:3000](http://localhost:3000).
38
38
Notes:
39
39
40
40
- The repo is mounted into the container, so local file edits are reflected in the preview.
41
-
- The image installs `mintlify@4.2.28` globally.
41
+
- The image installs `mint@4.2.516` globally.
42
42
- Port `3000` is exposed by default.
43
43
44
44
### Alternative: Run Mintlify locally
45
45
46
46
If you prefer running the CLI directly, install the same version pinned in Docker:
47
47
48
48
```bash
49
-
npm install -g mintlify@4.2.28
49
+
npm install -g mint@4.2.516
50
50
```
51
51
52
52
From the repository root, run:
53
53
54
54
```bash
55
-
mintlify dev
55
+
mint dev
56
56
```
57
57
58
-
If Mintlify reports missing local dependencies, run:
58
+
If the CLI reports that it is outdated, run:
59
59
60
60
```bash
61
-
mintlify install
61
+
mint update
62
62
```
63
63
64
64
## Editing Workflow
65
65
66
66
1. Update or add `.mdx` pages under the appropriate section directory.
67
-
2. If a page should appear in the docs navigation, add it to [mint.json](/Users/anurlybayev/Developer/codex/centml_platform_docs/mint.json).
68
-
3. Put screenshots and local images in [images/](/Users/anurlybayev/Developer/codex/centml_platform_docs/images) and reference them with `/images/...` paths.
69
-
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.
67
+
2. If a page should appear in the docs navigation, add it to [docs.json](docs.json).
68
+
3. Put screenshots and local images in [images/](images) and reference them with `/images/...` paths.
69
+
4. Reuse helpers from [snippets/components.mdx](snippets/components.mdx) when a page needs the shared hero card or banner components.
70
70
5. Preview locally before opening a PR, especially for image paths, imports, and navigation changes.
71
71
72
72
## How Publishing Works
@@ -77,13 +77,13 @@ If you need admin access to the Mintlify project, follow the internal process re
77
77
78
78
## Important Notes
79
79
80
-
-`mint.json` is the source of truth for what appears in the left navigation.
80
+
-`docs.json` is the source of truth for what appears in the left navigation.
81
81
- Not every file in the repository is currently linked from navigation.
82
82
- 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.
83
-
-Avoid casually upgrading Mintlify beyond `4.2.28` until the preview and deployed site are revalidated.
83
+
-After a Mintlify upgrade, recheck the local preview to confirm navigation, layout, and brand colors still render as expected.
84
84
85
85
## Troubleshooting
86
86
87
-
- If the preview does not start, make sure you are running the command from the repository root where `mint.json` lives.
88
-
- If a page returns `404`, confirm the file exists and that its route is correctly listed in `mint.json` when navigation is expected.
89
-
- If local Mintlify behaves differently from Docker, trust the Docker flow first because it is version-pinned in the repo.
87
+
- If the preview does not start, make sure you are running the command from the repository root where `docs.json` lives.
88
+
- If a page returns `404`, confirm the file exists and that its route is correctly listed in `docs.json` when navigation is expected.
89
+
- If local Mintlify behaves differently from Docker, trust the Docker flow first because it is the repository’s default preview path.
@@ -26,7 +26,7 @@ Once the instance is ready, navigate to the deployment details page. The **Endpo
26
26
-**Endpoint URL** — the hostname for your instance. Next to it are the copy button (copies the URL) and the SSH button (copies `ssh root@<endpoint_url>` so you can paste it directly into your terminal).
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.
43
43
44
44
45
-
# What's Next
45
+
##What's next
46
46
47
-
<CardGroupcols={2}>
48
-
<Card
49
-
title="LLM Serving"
50
-
icon="messages"
51
-
href="/apps/llm"
52
-
>
53
-
Explore dedicated public and private endpoints for production model deployments.
54
-
</Card>
47
+
<CardGroupcols={3}>
55
48
<Card
56
49
title="Clients"
57
50
icon="terminal"
@@ -67,17 +60,10 @@ The instance comes preloaded with the libraries included in your selected base i
67
60
Learn how to create private inference endpoints
68
61
</Card>
69
62
<Card
70
-
title="Submit a Support Request"
71
-
icon="headset"
72
-
href="/resources/requesting_support"
63
+
title="LLM Serving"
64
+
icon="messages"
65
+
href="/apps/llm"
73
66
>
74
-
Submit a Support Request.
67
+
Explore dedicated public and private endpoints for production model deployments.
75
68
</Card>
76
-
<Card
77
-
title="Agents on NVIDIA CCluster"
78
-
icon="user-secret"
79
-
href="/resources/json_and_tool"
80
-
>
81
-
Learn how agents can interact with NVIDIA CCluster services.
Copy file name to clipboardExpand all lines: apps/llm.mdx
+4-18Lines changed: 4 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Deploy dedicated LLM endpoints that fits your performance requirements and budge
10
10
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.
<imgsrc="/images/llm_stage1.png"alt="LLM Serving page showing available models"style={{ borderRadius: '0.5rem' }} />
14
14
</Frame>
15
15
16
16
<Tip>
@@ -21,7 +21,7 @@ Make sure you have been granted access to the model you selected. If not, please
21
21
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:
0 commit comments