RunPod documentation site

This website is built using Mintlify.

Publishing Changes

Create a pull request to make document changes, and request a review from @muhsinking. Changes will be deployed to production automatically after they are pushed to the main branch.

Running the docs locally

Install Mintlify:

npm i -g mintlify```

Start a local development server on your browser:

```shell
mintlify dev

Most changes will be reflected live without having to restart the server.

Linting

• Install vale
• Lint a specific folder or file, run:

vale path/to/docs/
# or
vale path/to/*.md

Format Python code examples

Install blacken-docs.

python -m pip install blacken-docs

Run the formatter.

yarn format

git ls-files -z -- '*.md' | xargs -0 blacken-docs

Update CPU and GPUs

python helpers/gpu-types.py
python helpers/cpu-types.py