diff --git a/containers.mdx b/containers.mdx index 6b4fadbff..e18663071 100644 --- a/containers.mdx +++ b/containers.mdx @@ -1,5 +1,6 @@ --- title: "Containers" +description: "Learn how to build, package, and deploy containerized applications on Runpod." --- diff --git a/flash/cli/app.mdx b/flash/cli/app.mdx index 50912d2bf..7afbf3278 100644 --- a/flash/cli/app.mdx +++ b/flash/cli/app.mdx @@ -1,6 +1,7 @@ --- title: "app" sidebarTitle: "app" +description: "Create, inspect, list, and delete Runpod Flash applications and their deployment environments." --- Manage Flash applications. An app is the top-level container that groups your deployment environments, build artifacts, and configuration. diff --git a/flash/cli/build.mdx b/flash/cli/build.mdx index 53b368844..9669ab8e7 100644 --- a/flash/cli/build.mdx +++ b/flash/cli/build.mdx @@ -1,6 +1,7 @@ --- title: "build" sidebarTitle: "build" +description: "Build a deployment-ready Runpod Flash artifact without deploying it." --- Build a deployment-ready artifact for your Flash application without deploying. Use this for more control over the build process or to inspect the artifact before deploying. diff --git a/flash/cli/deploy.mdx b/flash/cli/deploy.mdx index d1fdf4d40..4ad65b482 100644 --- a/flash/cli/deploy.mdx +++ b/flash/cli/deploy.mdx @@ -1,6 +1,7 @@ --- title: "deploy" sidebarTitle: "deploy" +description: "Build and deploy a Runpod Flash application to Serverless with configurable environments and build options." --- Build and deploy your Flash application to Runpod Serverless endpoints in one step. This is the primary command for getting your application running in the cloud. diff --git a/flash/cli/dev.mdx b/flash/cli/dev.mdx index 4ff0d6306..8e944348d 100644 --- a/flash/cli/dev.mdx +++ b/flash/cli/dev.mdx @@ -1,6 +1,7 @@ --- title: "dev" sidebarTitle: "dev" +description: "Start the Runpod Flash local development server and test endpoint functions on Serverless." --- Start the Flash development server for local testing with automatic updates. A local development server provides a unified interface for testing while `@Endpoint` functions execute on Runpod Serverless. diff --git a/flash/cli/env.mdx b/flash/cli/env.mdx index 7d4494bae..2094151bd 100644 --- a/flash/cli/env.mdx +++ b/flash/cli/env.mdx @@ -1,6 +1,7 @@ --- title: "env" sidebarTitle: "env" +description: "Create, inspect, list, and delete deployment environments for Runpod Flash applications." --- Manage deployment environments for Flash applications. Environments are isolated deployment contexts (like `dev`, `staging`, `production`) within a Flash app. diff --git a/flash/cli/init.mdx b/flash/cli/init.mdx index f5085402b..b54854b16 100644 --- a/flash/cli/init.mdx +++ b/flash/cli/init.mdx @@ -1,6 +1,7 @@ --- title: "init" sidebarTitle: "init" +description: "Create a Runpod Flash project with a FastAPI server, example workers, and deployment configuration." --- Create a new Flash project with a ready-to-use template structure including a FastAPI server, example GPU and CPU workers, and configuration files. diff --git a/flash/cli/login.mdx b/flash/cli/login.mdx index 03b845bd3..7ed22fac7 100644 --- a/flash/cli/login.mdx +++ b/flash/cli/login.mdx @@ -1,6 +1,7 @@ --- title: "login" sidebarTitle: "login" +description: "Authenticate the Runpod Flash CLI and save your API key for future Flash operations." --- Authenticate with Runpod and save your API key for all Flash operations, including CLI commands and standalone `@Endpoint` functions. diff --git a/flash/cli/undeploy.mdx b/flash/cli/undeploy.mdx index 51b597434..69c889873 100644 --- a/flash/cli/undeploy.mdx +++ b/flash/cli/undeploy.mdx @@ -1,6 +1,7 @@ --- title: "undeploy" sidebarTitle: "undeploy" +description: "List and remove Runpod Serverless endpoints created by Flash development and deployment workflows." --- Manage and delete Runpod Serverless endpoints deployed via Flash. Use this command to clean up endpoints created during local development with `flash dev`. diff --git a/flash/cli/update.mdx b/flash/cli/update.mdx index fd70b0f6e..155301176 100644 --- a/flash/cli/update.mdx +++ b/flash/cli/update.mdx @@ -1,6 +1,7 @@ --- title: "update" sidebarTitle: "update" +description: "Update the Runpod Flash CLI to the latest release or install a specific version." --- Update the Flash CLI to the latest version or a specific version. The command fetches version information from PyPI and installs using uv (when available) or pip. diff --git a/instant-clusters/axolotl.mdx b/instant-clusters/axolotl.mdx index c7643783c..e22b92a60 100644 --- a/instant-clusters/axolotl.mdx +++ b/instant-clusters/axolotl.mdx @@ -1,6 +1,7 @@ --- title: "Deploy an Instant Cluster with Axolotl" sidebarTitle: "Axolotl" +description: "Deploy Axolotl across multiple nodes on Runpod Clusters to fine-tune large language models." --- import { TrainingTooltip, InferenceTooltip } from "/snippets/tooltips.jsx"; diff --git a/instant-clusters/pytorch.mdx b/instant-clusters/pytorch.mdx index ad913bcc3..ef837cc31 100644 --- a/instant-clusters/pytorch.mdx +++ b/instant-clusters/pytorch.mdx @@ -1,6 +1,7 @@ --- title: "Deploy an Instant Cluster with PyTorch" sidebarTitle: "PyTorch" +description: "Run distributed PyTorch workloads across multiple nodes on Runpod Clusters." --- import { PyTorchTooltip } from "/snippets/tooltips.jsx"; diff --git a/instant-clusters/slurm.mdx b/instant-clusters/slurm.mdx index 6e2386a2c..e30a2bc27 100644 --- a/instant-clusters/slurm.mdx +++ b/instant-clusters/slurm.mdx @@ -1,6 +1,7 @@ --- -title: "Deploy an Instant Cluster with Slurm (unmanaged)" +title: "Deploy Slurm on a Cluster (unmanaged)" sidebarTitle: "Slurm (unmanaged)" +description: "Configure and manage an unmanaged Slurm deployment across multiple nodes on Runpod Clusters." --- import { SlurmTooltip } from "/snippets/tooltips.jsx"; diff --git a/integrations/transformer-lab.mdx b/integrations/transformer-lab.mdx index 931087f0d..2eea73d81 100644 --- a/integrations/transformer-lab.mdx +++ b/integrations/transformer-lab.mdx @@ -1,5 +1,5 @@ --- -title: "Run ML experiments on Runpod with Transformer Lab" +title: "Run Transformer Lab experiments on Runpod" sidebarTitle: "Transformer Lab" description: "Configure Transformer Lab to run ML training and inference workloads on Runpod GPUs. Review configuration and usage guidance for this Runpod integration." --- diff --git a/pods/troubleshooting/jupyterlab-checkpoints-folder.mdx b/pods/troubleshooting/jupyterlab-checkpoints-folder.mdx index d9b9153e7..14662b038 100644 --- a/pods/troubleshooting/jupyterlab-checkpoints-folder.mdx +++ b/pods/troubleshooting/jupyterlab-checkpoints-folder.mdx @@ -1,6 +1,7 @@ --- title: "JupyterLab checkpoints folder access" sidebarTitle: "JupyterLab checkpoints folder" +description: "Access folders named checkpoints in JupyterLab by temporarily renaming the directory on a Runpod Pod." --- If you're unable to open a folder named "checkpoints" in JupyterLab, this is a known issue where JupyterLab treats "checkpoints" as a reserved keyword. @@ -46,4 +47,4 @@ mv ~/downloaded-model.ckpt checkpoints/ ## Related information -This issue has been reported in multiple GitHub issues and affects both JupyterLab and classic Jupyter Notebook. The folder name "checkpoints" conflicts with Jupyter's internal checkpoint system for notebook files. \ No newline at end of file +This issue has been reported in multiple GitHub issues and affects both JupyterLab and classic Jupyter Notebook. The folder name "checkpoints" conflicts with Jupyter's internal checkpoint system for notebook files. diff --git a/pods/troubleshooting/storage-full.mdx b/pods/troubleshooting/storage-full.mdx index e04c63e22..f8a3c56ed 100644 --- a/pods/troubleshooting/storage-full.mdx +++ b/pods/troubleshooting/storage-full.mdx @@ -1,5 +1,6 @@ --- title: "Storage full" +description: "Diagnose full container or volume storage and recover disk space on a Runpod Pod." --- Storage full errors can occur when users generate many files, transfer files, or perform other storage-intensive tasks. This document provides guidance to help you troubleshoot this. @@ -101,4 +102,4 @@ ls -d /workspace/.Trash* 2>/dev/null && rm -rf /workspace/.Trash* && echo "✓ C ## Additional storage -If your Pod needs more than 20GB of storage, consider using a network volume. For more information, see [Network volumes](/storage/network-volumes), or refer to [this blog post](https://www.runpod.io/blog/network-volumes-on-runpod-secure-cloud). \ No newline at end of file +If your Pod needs more than 20GB of storage, consider using a network volume. For more information, see [Network volumes](/storage/network-volumes), or refer to [this blog post](https://www.runpod.io/blog/network-volumes-on-runpod-secure-cloud). diff --git a/pods/troubleshooting/token-authentication-enabled.mdx b/pods/troubleshooting/token-authentication-enabled.mdx index c9f2350ff..99625c5af 100644 --- a/pods/troubleshooting/token-authentication-enabled.mdx +++ b/pods/troubleshooting/token-authentication-enabled.mdx @@ -1,5 +1,6 @@ --- title: "JupyterLab server token authentication" +description: "Find your JupyterLab server token and sign in when token authentication is enabled on a Runpod Pod." --- If you see a "Token authentication is enabled" screen when trying to access your Pod's JupyterLab server, follow the steps below to log in. diff --git a/pods/troubleshooting/troubleshooting-502-errors.mdx b/pods/troubleshooting/troubleshooting-502-errors.mdx index f1a7d1f6a..625842631 100644 --- a/pods/troubleshooting/troubleshooting-502-errors.mdx +++ b/pods/troubleshooting/troubleshooting-502-errors.mdx @@ -1,5 +1,6 @@ --- title: "502 errors" +description: "Diagnose and resolve 502 errors when accessing applications running on a Runpod Pod." --- 502 errors can occur when users attempt to access a program running on a specific port of a deployed Pod and the program isn't running or has encountered an error. This document provides guidance to help you troubleshoot this error. diff --git a/references/cpu-types.mdx b/references/cpu-types.mdx index ba32970e4..97b1d4c64 100644 --- a/references/cpu-types.mdx +++ b/references/cpu-types.mdx @@ -1,5 +1,6 @@ --- title: CPU types +description: "Compare the CPU types available on Runpod, including core counts and thread configurations." --- The following list contains all CPU types available on Runpod. diff --git a/runpodctl/reference/runpodctl-billing.mdx b/runpodctl/reference/runpodctl-billing.mdx index 466399ba3..92c0f820a 100644 --- a/runpodctl/reference/runpodctl-billing.mdx +++ b/runpodctl/reference/runpodctl-billing.mdx @@ -1,6 +1,7 @@ --- title: "billing" sidebarTitle: "billing" +description: "View billing history for Runpod Pods, Serverless endpoints, and network volumes with runpodctl." --- View billing history for Pods, Serverless endpoints, and network volumes. diff --git a/runpodctl/reference/runpodctl-config.mdx b/runpodctl/reference/runpodctl-config.mdx index 5420b5db8..7276e7604 100644 --- a/runpodctl/reference/runpodctl-config.mdx +++ b/runpodctl/reference/runpodctl-config.mdx @@ -1,6 +1,7 @@ --- title: "config" sidebarTitle: "config" +description: "Configure runpodctl with your Runpod API credentials and API URL." --- Configure the Runpod CLI with your API credentials and API URL to enable programmatic access to your Runpod resources. diff --git a/runpodctl/reference/runpodctl-datacenter.mdx b/runpodctl/reference/runpodctl-datacenter.mdx index d74026f8a..2d3795913 100644 --- a/runpodctl/reference/runpodctl-datacenter.mdx +++ b/runpodctl/reference/runpodctl-datacenter.mdx @@ -1,6 +1,7 @@ --- title: "datacenter" sidebarTitle: "datacenter" +description: "List Runpod data centers and their locations from the command line with runpodctl." --- List available datacenters and their locations. diff --git a/runpodctl/reference/runpodctl-doctor.mdx b/runpodctl/reference/runpodctl-doctor.mdx index 5fc5755fa..e7e89a279 100644 --- a/runpodctl/reference/runpodctl-doctor.mdx +++ b/runpodctl/reference/runpodctl-doctor.mdx @@ -1,6 +1,7 @@ --- title: "doctor" sidebarTitle: "doctor" +description: "Diagnose runpodctl configuration issues and set up API and SSH credentials for the Runpod CLI." --- Diagnose and fix CLI issues, including first-time setup for API keys and SSH configuration. diff --git a/runpodctl/reference/runpodctl-gpu.mdx b/runpodctl/reference/runpodctl-gpu.mdx index 584fcae97..276ab3792 100644 --- a/runpodctl/reference/runpodctl-gpu.mdx +++ b/runpodctl/reference/runpodctl-gpu.mdx @@ -1,6 +1,7 @@ --- title: "gpu" sidebarTitle: "gpu" +description: "List Runpod GPU types, availability, and specifications from the command line with runpodctl." --- List available GPU types and their specifications. diff --git a/runpodctl/reference/runpodctl-hub.mdx b/runpodctl/reference/runpodctl-hub.mdx index 9f8aca35e..2e95dc04f 100644 --- a/runpodctl/reference/runpodctl-hub.mdx +++ b/runpodctl/reference/runpodctl-hub.mdx @@ -1,6 +1,7 @@ --- title: "hub" sidebarTitle: "hub" +description: "Browse and search deployable repositories in the Runpod Hub with runpodctl." --- Browse and search the Runpod Hub marketplace to discover deployable repos. You can list popular repos, search by name, and get details for specific repos. Use Hub repo IDs with [`runpodctl serverless create --hub-id`](/runpodctl/reference/runpodctl-serverless) to deploy endpoints directly from the Hub. diff --git a/runpodctl/reference/runpodctl-network-volume.mdx b/runpodctl/reference/runpodctl-network-volume.mdx index 06f9653ae..f4bce8651 100644 --- a/runpodctl/reference/runpodctl-network-volume.mdx +++ b/runpodctl/reference/runpodctl-network-volume.mdx @@ -1,6 +1,7 @@ --- title: "network-volume" sidebarTitle: "network-volume" +description: "Create, inspect, and manage persistent Runpod network volumes with runpodctl." --- Manage network volumes for persistent shared storage across Pods and Serverless endpoints. diff --git a/runpodctl/reference/runpodctl-pod.mdx b/runpodctl/reference/runpodctl-pod.mdx index 3ae1c05b4..8d74ef77b 100644 --- a/runpodctl/reference/runpodctl-pod.mdx +++ b/runpodctl/reference/runpodctl-pod.mdx @@ -1,6 +1,7 @@ --- title: "pod" sidebarTitle: "pod" +description: "Create, list, start, stop, and delete Runpod Pods from the command line with runpodctl." --- Manage Pods, including creating, listing, starting, stopping, and deleting Pods. diff --git a/runpodctl/reference/runpodctl-receive.mdx b/runpodctl/reference/runpodctl-receive.mdx index 3a00ba63b..ec729666f 100644 --- a/runpodctl/reference/runpodctl-receive.mdx +++ b/runpodctl/reference/runpodctl-receive.mdx @@ -1,6 +1,7 @@ --- title: "receive" sidebarTitle: "receive" +description: "Receive files or folders over a secure peer-to-peer connection with runpodctl." --- Receive files or folders sent from another machine using a secure peer-to-peer connection established with a connection code. diff --git a/runpodctl/reference/runpodctl-registry.mdx b/runpodctl/reference/runpodctl-registry.mdx index 44145537d..6c4a6ba81 100644 --- a/runpodctl/reference/runpodctl-registry.mdx +++ b/runpodctl/reference/runpodctl-registry.mdx @@ -1,6 +1,7 @@ --- title: "registry" sidebarTitle: "registry" +description: "Manage private container registry credentials for Runpod deployments with runpodctl." --- Manage container registry authentications for private Docker images. diff --git a/runpodctl/reference/runpodctl-send.mdx b/runpodctl/reference/runpodctl-send.mdx index 141f17144..5860a3aca 100644 --- a/runpodctl/reference/runpodctl-send.mdx +++ b/runpodctl/reference/runpodctl-send.mdx @@ -1,6 +1,7 @@ --- title: "send" sidebarTitle: "send" +description: "Send files or folders to a Runpod Pod or another computer with runpodctl." --- Transfer files or folders from your local machine to a Pod or another computer using a secure peer-to-peer connection. diff --git a/runpodctl/reference/runpodctl-serverless.mdx b/runpodctl/reference/runpodctl-serverless.mdx index a80cd6f13..bc90ae754 100644 --- a/runpodctl/reference/runpodctl-serverless.mdx +++ b/runpodctl/reference/runpodctl-serverless.mdx @@ -1,6 +1,7 @@ --- title: "serverless" sidebarTitle: "serverless" +description: "Create, list, update, and delete Runpod Serverless endpoints with runpodctl." --- import { VolumeDiskTooltip } from "/snippets/tooltips.jsx"; diff --git a/runpodctl/reference/runpodctl-ssh.mdx b/runpodctl/reference/runpodctl-ssh.mdx index f2bfd18f8..9fce5b65c 100644 --- a/runpodctl/reference/runpodctl-ssh.mdx +++ b/runpodctl/reference/runpodctl-ssh.mdx @@ -1,6 +1,7 @@ --- title: "ssh" sidebarTitle: "ssh" +description: "Manage SSH keys and retrieve Pod connection information with runpodctl." --- Manage SSH keys and get SSH connection information for Pods. diff --git a/runpodctl/reference/runpodctl-template.mdx b/runpodctl/reference/runpodctl-template.mdx index e32c5bbd2..a649c4450 100644 --- a/runpodctl/reference/runpodctl-template.mdx +++ b/runpodctl/reference/runpodctl-template.mdx @@ -1,6 +1,7 @@ --- title: "template" sidebarTitle: "template" +description: "List, search, inspect, and manage Runpod deployment templates with runpodctl." --- import { VolumeDiskTooltip } from "/snippets/tooltips.jsx"; diff --git a/runpodctl/reference/runpodctl-update.mdx b/runpodctl/reference/runpodctl-update.mdx index 9517bca01..0ccb76c8d 100644 --- a/runpodctl/reference/runpodctl-update.mdx +++ b/runpodctl/reference/runpodctl-update.mdx @@ -1,6 +1,7 @@ --- title: "update" sidebarTitle: "update" +description: "Update runpodctl to the latest available version and verify the installed release." --- Update `runpodctl` to the latest version to access new features and bug fixes. diff --git a/runpodctl/reference/runpodctl-user.mdx b/runpodctl/reference/runpodctl-user.mdx index cba022aec..3c2fa721b 100644 --- a/runpodctl/reference/runpodctl-user.mdx +++ b/runpodctl/reference/runpodctl-user.mdx @@ -1,6 +1,7 @@ --- title: "user" sidebarTitle: "user" +description: "View your Runpod account information and current balance from the command line with runpodctl." --- View your account information and current balance. diff --git a/runpodctl/reference/runpodctl-version.mdx b/runpodctl/reference/runpodctl-version.mdx index 85ca4b10a..cd64bbd4c 100644 --- a/runpodctl/reference/runpodctl-version.mdx +++ b/runpodctl/reference/runpodctl-version.mdx @@ -1,6 +1,7 @@ --- title: "version" sidebarTitle: "version" +description: "Display the installed runpodctl version and confirm that your Runpod CLI is current." --- Display the current version of `runpodctl` installed on your system. diff --git a/serverless/workers/github-integration.mdx b/serverless/workers/github-integration.mdx index 70d62d0a6..94d8a17a6 100644 --- a/serverless/workers/github-integration.mdx +++ b/serverless/workers/github-integration.mdx @@ -33,7 +33,7 @@ For an example repository containing the minimal files necessary for deployment, Before deploying from GitHub, you need to authorize Runpod to access your repositories: -1. Open the [settings page](http://console.runpod.io/user/settings) in the Runpod console. +1. Open the [settings page](https://console.runpod.io/user/settings) in the Runpod console. 2. Find the **GitHub** card under **Connections** and click **Connect**. diff --git a/tips-and-tricks/tmux.mdx b/tips-and-tricks/tmux.mdx index 39b143808..63fb70bd4 100644 --- a/tips-and-tricks/tmux.mdx +++ b/tips-and-tricks/tmux.mdx @@ -1,6 +1,7 @@ --- title: "Using TMUX for persistent sessions" sidebarTitle: "Persistent sessions with TMUX" +description: "Use TMUX on a Runpod Pod to keep terminal sessions and long-running workloads active after you disconnect." icon: "square-terminal" --- diff --git a/tutorials/pods/run-your-first.mdx b/tutorials/pods/run-your-first.mdx index 2c3bdc018..e931b3cbb 100644 --- a/tutorials/pods/run-your-first.mdx +++ b/tutorials/pods/run-your-first.mdx @@ -1,5 +1,5 @@ --- -title: "Run LLMs with JupyterLab using the transformers library" +title: "Run LLMs in JupyterLab with transformers" sidebarTitle: "Run LLMs with JupyterLab" description: "Learn how to run inference on the SmolLM3 model in JupyterLab using the transformers library. Follow the implementation steps in this Runpod tutorial." --- @@ -172,4 +172,4 @@ Now that you have SmolLM3 running, you can explore more advanced use cases: - **Integration with applications**: Use SmolLM3 as part of larger applications by integrating it with web frameworks or APIs. - **Model comparison**: Try other models in the SmolLM3 family or compare with other small language models to find the best fit for your use case. -- **Persistent storage**: If you plan to work with SmolLM3 regularly, consider using a to persist your models and notebooks across Pod sessions. \ No newline at end of file +- **Persistent storage**: If you plan to work with SmolLM3 regularly, consider using a to persist your models and notebooks across Pod sessions. diff --git a/tutorials/serverless/run-gemma-7b.mdx b/tutorials/serverless/run-gemma-7b.mdx index 1b9798329..f4c7bb8c9 100644 --- a/tutorials/serverless/run-gemma-7b.mdx +++ b/tutorials/serverless/run-gemma-7b.mdx @@ -1,5 +1,5 @@ --- -title: "Deploy a chatbot with Gemma 3 and send requests using the OpenAI API" +title: "Deploy a Gemma 3 chatbot with the OpenAI API" sidebarTitle: "Create a chatbot with Gemma 3" description: "Deploy a Serverless endpoint with Google's Gemma 3 model using vLLM and the OpenAI API to build an interactive chatbot." ---