sglang/docs_new/README.md

SGLang Documentation

The official documentation and cookbook for SGLang — a high-performance serving framework for large language models and vision-language models.

• Docs: Getting started guides, installation, and reference
• Cookbook: Battle-tested recipes for deploying specific models (Qwen, DeepSeek, Llama, GLM, etc.) on various hardware

Project structure

.
├── docs.json              # Site configuration (navigation, theme, metadata)
├── index.mdx              # Homepage
├── docs/                  # Documentation pages
│   └── get-started/
│       └── install.mdx    # Installation guide
└── cookbook/               # Model deployment recipes
    ├── intro.mdx           # Cookbook overview and recipe index
    └── autoregressive/     # Autoregressive model recipes
        └── Qwen/
            └── Qwen3.5.mdx

Pages are .mdx files with YAML frontmatter. Navigation is defined in docs.json.

Local development

Prerequisites

• Node.js >= 20

Setup

# Install the CLI
npm i -g mint

# Start the dev server (with hot reload)
mint dev

Preview at http://localhost:3000.

Useful commands

mint dev            # Start local preview server
mint broken-links   # Check for broken links
mint update         # Update the CLI

Contributing

We welcome contributions! Whether you want to add a recipe for a new model, improve existing docs, or fix a typo — PRs are appreciated.

Quick edit (GitHub)

1. Navigate to the file you want to edit on GitHub
2. Click the pencil icon to edit
3. Submit a pull request

Local development workflow

# 1. Fork and clone the repo
git clone https://github.com/<YOUR_USERNAME>/sgl-docs.git
cd sgl-docs

# 2. Create a branch
git checkout -b my-changes

# 3. Start the dev server and make your changes
mint dev

# 4. Verify links aren't broken
mint broken-links

# 5. Commit and push
git add <files>
git commit -m "docs: describe your change"
git push origin my-changes

# 6. Open a pull request on GitHub

Adding a new cookbook recipe

1. Create a new .mdx file under cookbook/ following the existing directory structure (e.g., cookbook/llm/<Vendor>/<Model>.mdx or cookbook/vlm/<Vendor>/<Model>.mdx)
2. Use an existing recipe like cookbook/llm/Qwen/Qwen3.5.mdx as a template
3. Add your page to the navigation in docs.json
4. Each recipe should include:
   • Model introduction and key specs
   • Installation / environment setup
   • Deployment configuration (with hardware recommendations)
   • Usage examples (basic + advanced)
   • Benchmarks (if available)

Writing guidelines

• Use active voice: "Run the command" not "The command should be run"
• Address the reader as "you"
• Keep sentences concise — one idea per sentence
• Lead with the goal, then the steps
• Use consistent terminology
• Include concrete examples and code snippets

Acknowledgements

Thank you to all the authors who contributed to the original documentation in sglang/docs/ and the original cookbook in sgl-cookbook. The migration to the new Mintlify-based documentation was led by the following ACM_VIT students:

@Adhyan Jain, @Maitri-shah29, @architnigam, @Nakul-Sinha, @divyamagrawal06, @A-Taman, @nimeshas, @IshhanKheria, @Krishang-Zinzuwadia, @pokymono, @Ishitajoshii, @AdityaVKochar

Advised by @adarshxs (ACM_VIT) and @wisclmy0611, @Richardczl98 (LMSYS).

Community

• GitHub
• Slack
• Discord
• X / Twitter
• LinkedIn

License

Apache License 2.0 — see the LICENSE for details.