diff --git a/docs.json b/docs.json index a050f4d2..29a25d12 100644 --- a/docs.json +++ b/docs.json @@ -1,6 +1,6 @@ { "$schema": "https://mintlify.com/docs.json", - "theme": "willow", + "theme": "palm", "name": "Runpod Documentation", "colors": { "primary": "#5D29F0", @@ -32,73 +32,87 @@ "navigation": { "tabs": [ { - "tab": "Documentation", + "tab": "Start here", "groups": [ { - "group": "Get started", + "group": "Setup", "pages": [ "overview", - "get-started", "get-started/manage-accounts", "get-started/api-keys", "get-started/connect-to-runpod" ] }, { - "group": "Serverless", + "group": "Runpod Hub", + "pages": [ + "hub/overview", + "hub/public-endpoints", + "hub/publishing-guide" + ] + } + ] + }, + { + "tab": "Serverless", + "groups": [ + { + "group": "Get started", "pages": [ "serverless/overview", - "serverless/pricing", - { - "group": "Workers", - "pages": [ - "serverless/workers/overview", - "serverless/workers/custom-worker", - "serverless/workers/handler-functions", - "serverless/workers/concurrent-handler", - "serverless/workers/deploy", - "serverless/workers/github-integration" - ] - }, - { - "group": "Endpoints", - "pages": [ - "serverless/endpoints/overview", - "serverless/endpoints/manage-endpoints", - "serverless/endpoints/send-requests", - "serverless/endpoints/operations", - "serverless/endpoints/endpoint-configurations", - "serverless/endpoints/job-states" - ] - }, - { - "group": "Storage", - "pages": [ - "serverless/storage/overview", - "serverless/storage/network-volumes", - "serverless/storage/s3-api" - ] - }, - { - "group": "vLLM workers", - "pages": [ - "serverless/vllm/overview", - "serverless/vllm/get-started", - "serverless/vllm/vllm-requests", - "serverless/vllm/openai-compatibility" - ] - }, - { - "group": "Load balancing endpoints", - "pages": [ - "serverless/load-balancing/overview", - "serverless/load-balancing/build-a-worker", - "serverless/load-balancing/vllm-worker" - ] - }, - { - "group": "Development", - "pages": [ + "serverless/pricing" + ] + }, + { + "group": "Workers", + "pages": [ + "serverless/workers/overview", + "serverless/workers/custom-worker", + "serverless/workers/handler-functions", + "serverless/workers/concurrent-handler", + "serverless/workers/deploy", + "serverless/workers/github-integration" + ] + }, + { + "group": "Endpoints", + "pages": [ + "serverless/endpoints/overview", + "serverless/endpoints/manage-endpoints", + "serverless/endpoints/send-requests", + "serverless/endpoints/operations", + "serverless/endpoints/endpoint-configurations", + "serverless/endpoints/job-states" + ] + }, + { + "group": "Storage", + "pages": [ + "serverless/storage/overview", + "serverless/storage/network-volumes", + "serverless/storage/s3-api" + ] + }, + { + "group": "vLLM workers", + "pages": [ + "serverless/vllm/overview", + "serverless/vllm/get-started", + "serverless/vllm/vllm-requests", + "serverless/vllm/openai-compatibility" + ] + }, + { + "group": "Load balancing endpoints", + "pages": [ + "serverless/load-balancing/overview", + "serverless/load-balancing/build-a-worker", + "serverless/load-balancing/vllm-worker" + ] + }, + { + "group": "Development", + "pages": [ "serverless/development/logs", "serverless/development/overview", "serverless/development/local-testing", @@ -114,20 +128,18 @@ ] }, { - "group": "Hub", - "pages": [ - "hub/overview", - "hub/public-endpoints", - "hub/publishing-guide" - ] - }, - { - "group": "Pods", - "pages": [ - "pods/overview", - "pods/pricing", - "pods/choose-a-pod", - "pods/manage-pods", + "tab": "Pods", + "groups": [ + { + "group": "Get started", + "pages": [ + "pods/overview", + "get-started", + "pods/pricing", + "pods/choose-a-pod", + "pods/manage-pods" + ] + }, { "group": "Connect to Pods", "pages": [ @@ -152,80 +164,37 @@ "pages": [ "pods/templates/overview", "pods/templates/manage-templates", - "pods/templates/secrets" + "pods/templates/secrets", + "pods/references/environment-variables" ] }, - "pods/references/environment-variables" - ] - }, - { - "group": "Instant Clusters", - "pages": [ - "instant-clusters", - "instant-clusters/slurm-clusters", { - "group": "Deployment guides", + "group": "Instant Clusters", "pages": [ - "instant-clusters/pytorch", - "instant-clusters/axolotl", - "instant-clusters/slurm" + "instant-clusters", + "instant-clusters/slurm-clusters", + { + "group": "Deployment guides", + "pages": [ + "instant-clusters/pytorch", + "instant-clusters/axolotl", + "instant-clusters/slurm" + ] + } ] - } - - ] - }, - { - "group": "Fine-tuning", - "pages": [ - "fine-tune" - ] - }, - { - "group": "Integrations", - "pages": [ - "integrations/dstack", - "integrations/mods", - "integrations/skypilot" - ] - }, - { - "group": "Hosting", - "pages": [ - "hosting/overview", - "hosting/burn-testing", - "hosting/maintenance-and-reliability", - "hosting/partner-requirements" + }, + { + "group": "Fine-tuning", + "pages": [ + "fine-tune" + ] + } ] }, - { - "group": "References", - "pages": [ - "references/faq", - "references/glossary", - "references/billing-information", - "references/referrals", - "references/gpu-types", - "references/cpu-types", - { - "group": "Troubleshooting", - "pages": [ - "references/troubleshooting/leaked-api-keys", - "references/troubleshooting/storage-full", - "references/troubleshooting/troubleshooting-502-errors", - "references/troubleshooting/token-authentication-enabled", - "references/faq/manage-cards" - ] - }, - "references/video-resources", - "references/graphql-spec" - ] - } - ] - }, { - "tab": "Tutorials", + "tab": "Examples", "groups": [ { "group": "Get started", @@ -316,20 +285,81 @@ ] }, { - "tab": "Community", + "tab": "REST API", "groups": [ { - "group": "Community solutions", + "group": "API Reference", "pages": [ - "community-solutions/overview", - "community-solutions/ohmyrunpod/overview", - "community-solutions/ssh-password-migration/overview", - "community-solutions/copyparty-file-manager/overview" - + { + "group": "pods", + "pages": [ + "api-reference/pods/POST/pods", + "api-reference/pods/GET/pods", + "api-reference/pods/GET/pods/podId", + "api-reference/pods/PATCH/pods/podId", + "api-reference/pods/DELETE/pods/podId", + "api-reference/pods/POST/pods/podId/update", + "api-reference/pods/POST/pods/podId/start", + "api-reference/pods/POST/pods/podId/stop", + "api-reference/pods/POST/pods/podId/reset", + "api-reference/pods/POST/pods/podId/restart" + ] + }, + { + "group": "endpoints", + "pages": [ + "api-reference/endpoints/POST/endpoints", + "api-reference/endpoints/GET/endpoints", + "api-reference/endpoints/GET/endpoints/endpointId", + "api-reference/endpoints/PATCH/endpoints/endpointId", + "api-reference/endpoints/DELETE/endpoints/endpointId", + "api-reference/endpoints/POST/endpoints/endpointId/update" + ] + }, + { + "group": "network volumes", + "pages": [ + "api-reference/network-volumes/POST/networkvolumes", + "api-reference/network-volumes/GET/networkvolumes", + "api-reference/network-volumes/GET/networkvolumes/networkVolumeId", + "api-reference/network-volumes/PATCH/networkvolumes/networkVolumeId", + "api-reference/network-volumes/DELETE/networkvolumes/networkVolumeId", + "api-reference/network-volumes/POST/networkvolumes/networkVolumeId/update" + ] + }, + { + "group": "templates", + "pages": [ + "api-reference/templates/POST/templates", + "api-reference/templates/GET/templates", + "api-reference/templates/GET/templates/templateId", + "api-reference/templates/PATCH/templates/templateId", + "api-reference/templates/DELETE/templates/templateId", + "api-reference/templates/POST/templates/templateId/update" + ] + }, + { + "group": "container registry auth", + "pages": [ + "api-reference/container-registry-auths/POST/containerregistryauth", + "api-reference/container-registry-auths/GET/containerregistryauth", + "api-reference/container-registry-auths/GET/containerregistryauth/containerRegistryAuthId", + "api-reference/container-registry-auths/DELETE/containerregistryauth/containerRegistryAuthId" + ] + }, + { + "group": "billing", + "pages": [ + "api-reference/billing/GET/billing/pods", + "api-reference/billing/GET/billing/endpoints", + "api-reference/billing/GET/billing/networkvolumes" + ] + } ] } ] }, + { "tab": "SDKs", "groups": [ @@ -377,7 +407,7 @@ ] }, { - "group": "Reference", + "group": "Commands", "pages": [ "runpodctl/reference/runpodctl", "runpodctl/reference/runpodctl-config", @@ -405,84 +435,62 @@ } ] }, + { - "tab": "API", + "tab": "Resources", "groups": [ { - "group": "API Reference", + "group": "Reference", "pages": [ - { - "group": "docs", - "pages": [ - "api-reference/docs/GET/openapi-json", - "api-reference/docs/GET/docs" - ] - }, - { - "group": "pods", - "pages": [ - "api-reference/pods/POST/pods", - "api-reference/pods/GET/pods", - "api-reference/pods/GET/pods/podId", - "api-reference/pods/PATCH/pods/podId", - "api-reference/pods/DELETE/pods/podId", - "api-reference/pods/POST/pods/podId/update", - "api-reference/pods/POST/pods/podId/start", - "api-reference/pods/POST/pods/podId/stop", - "api-reference/pods/POST/pods/podId/reset", - "api-reference/pods/POST/pods/podId/restart" - ] - }, - { - "group": "endpoints", - "pages": [ - "api-reference/endpoints/POST/endpoints", - "api-reference/endpoints/GET/endpoints", - "api-reference/endpoints/GET/endpoints/endpointId", - "api-reference/endpoints/PATCH/endpoints/endpointId", - "api-reference/endpoints/DELETE/endpoints/endpointId", - "api-reference/endpoints/POST/endpoints/endpointId/update" - ] - }, - { - "group": "network volumes", - "pages": [ - "api-reference/network-volumes/POST/networkvolumes", - "api-reference/network-volumes/GET/networkvolumes", - "api-reference/network-volumes/GET/networkvolumes/networkVolumeId", - "api-reference/network-volumes/PATCH/networkvolumes/networkVolumeId", - "api-reference/network-volumes/DELETE/networkvolumes/networkVolumeId", - "api-reference/network-volumes/POST/networkvolumes/networkVolumeId/update" - ] - }, - { - "group": "templates", - "pages": [ - "api-reference/templates/POST/templates", - "api-reference/templates/GET/templates", - "api-reference/templates/GET/templates/templateId", - "api-reference/templates/PATCH/templates/templateId", - "api-reference/templates/DELETE/templates/templateId", - "api-reference/templates/POST/templates/templateId/update" - ] - }, - { - "group": "container registry auth", - "pages": [ - "api-reference/container-registry-auths/POST/containerregistryauth", - "api-reference/container-registry-auths/GET/containerregistryauth", - "api-reference/container-registry-auths/GET/containerregistryauth/containerRegistryAuthId", - "api-reference/container-registry-auths/DELETE/containerregistryauth/containerRegistryAuthId" - ] - }, - { - "group": "billing", - "pages": [ - "api-reference/billing/GET/billing/pods", - "api-reference/billing/GET/billing/endpoints", - "api-reference/billing/GET/billing/networkvolumes" - ] - } + "references/glossary", + "references/faq", + "references/referrals", + "references/gpu-types", + "references/cpu-types", + "references/billing-information", + "references/video-resources", + "references/graphql-spec" + ] + }, + { + "group": "Troubleshooting", + "pages": [ + "references/troubleshooting/leaked-api-keys", + "references/troubleshooting/storage-full", + "references/troubleshooting/troubleshooting-502-errors", + "references/troubleshooting/token-authentication-enabled", + "references/faq/manage-cards" + ] + }, + { + "group": "Integrations", + "pages": [ + "integrations/dstack", + "integrations/mods", + "integrations/skypilot" + ] + }, + { + "group": "Hosting", + "pages": [ + "hosting/overview", + "hosting/burn-testing", + "hosting/maintenance-and-reliability", + "hosting/partner-requirements" + ] + } + ] + }, + { + "tab": "Community", "groups": [ + { + "group": "Community solutions", + "pages": [ + "community-solutions/overview", + "community-solutions/ohmyrunpod/overview", + "community-solutions/ssh-password-migration/overview", + "community-solutions/copyparty-file-manager/overview" + ] } ] @@ -493,12 +501,12 @@ { "anchor": "Console", "href": "https://console.runpod.io/", - "icon": "code" + "icon": "computer" }, { "anchor": "Blog", "href": "https://www.runpod.io/blog", - "icon": "newspaper" + "icon": "book-open" }, { "anchor": "Support", diff --git a/pods/overview.mdx b/pods/overview.mdx index b82c4234..04636738 100644 --- a/pods/overview.mdx +++ b/pods/overview.mdx @@ -1,5 +1,6 @@ --- -title: Overview +title: "Pods" +sidebarTitle: "Introduction" description: "Get on-demand access to powerful computing resources." --- diff --git a/runpodctl/overview.mdx b/runpodctl/overview.mdx index 4e0c8e9f..d58bf766 100644 --- a/runpodctl/overview.mdx +++ b/runpodctl/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Runpod CLI overview" -sidebarTitle: "Overview" +title: "Runpod CLI" +sidebarTitle: "Introduction" --- Runpod CLI is an [open source](https://github.com/runpod/runpodctl) command-line interface tool that simplifies the management of GPU [Pods](/pods/overview) and [Serverless](/serverless/overview) endpoints on the Runpod platform. You can use Runpod CLI to execute code on Pods, deploy endpoints, transfer data, and manage computing resources efficiently. diff --git a/serverless/overview.mdx b/serverless/overview.mdx index bcb71a18..af8ff4ea 100644 --- a/serverless/overview.mdx +++ b/serverless/overview.mdx @@ -1,5 +1,6 @@ --- -title: "Overview" +title: "Serverless" +sidebarTitle: "Introduction" description: "Pay-as-you-go compute for AI models and compute-intensive workloads." --- diff --git a/tutorials/introduction/overview.mdx b/tutorials/introduction/overview.mdx index 12e4c4a0..09b55b2b 100644 --- a/tutorials/introduction/overview.mdx +++ b/tutorials/introduction/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Featured tutorials" -sidebarTitle: "Featured tutorials" +title: "Featured examples" +sidebarTitle: "Featured examples" description: "Learn how to build and deploy AI applications on Runpod with step-by-step guides." ---