Skip to content

docs: deduplicate model-specific guides into the cookbook - #44135

Closed
Asthenia0412 wants to merge 1 commit into
sgl-project:mainfrom
Asthenia0412:yancy/docs-cookbook-dedup-18427
Closed

Asthenia0412 wants to merge 1 commit into
sgl-project:mainfrom
Asthenia0412:yancy/docs-cookbook-dedup-18427

Conversation

@Asthenia0412

@Asthenia0412 Asthenia0412 commented Oct 13, 2026 •

Copy link
Copy Markdown

Summary

Resolves the remaining docs/cookbook overlap from #18427.

Changes

Case 1 — cookbook already had the content (EmbeddingGemma)

  • ****: removed the condensed EmbeddingGemma subsection. The cookbook page at /cookbook/autoregressive/Google/EmbeddingGemma is authoritative and covers prerequisites, Hopper performance defaults, and deployment behavior. Replaced with a <Note> pointer. The model name in the supported-models table now links to the cookbook.

Case 2 — cookbook did not have the content (Qwen3-Reranker, Qwen3-VL-Reranker)

  • Moved the detailed sections from rerank_models.mdx (~240 lines: launch commands, request/response formats, multimodal examples, common pitfalls) into two new cookbook pages:
    • docs/cookbook/autoregressive/Qwen/Qwen3-Reranker.mdx
    • docs/cookbook/autoregressive/Qwen/Qwen3-VL-Reranker.mdx
  • rerank_models.mdx now keeps only the category-level cross-encoder guide, the supported-models table (model names link to cookbook), and a short summary of decoder-only deployment rules.

Navigation

  • Added both new cookbook pages to docs/docs.json under the Qwen group so they appear in the sidebar.

What was deliberately kept

The category-level quickstarts (client request examples, Matryoshka embedding, multimodal embedding example, cross-encoder rerank endpoint docs) are endpoint documentation rather than per-model duplication.

Already resolved during docs migration

The popular_model_usage.html -> /cookbook/autoregressive/intro redirect is already in docs.json, along with per-model redirects.

Refs #18427


CI States

Latest PR Test (Base): ✅ Run #38473313175
Latest PR Test (Extra): ❌ Run #38473313149
Latest PR Test (AMD ROCm 10): ➖ No AMD PR run found for this commit.

Resolves the remaining docs/cookbook overlap from #18427.

What changed (case 1 — cookbook already had the content):
- supported-models/embedding_models.mdx: removed the condensed EmbeddingGemma
  subsection (the cookbook page at /cookbook/autoregressive/Google/EmbeddingGemma
  is authoritative and covers prerequisites and Hopper performance defaults).
  Replaced with a <Note> pointer; the table row now links to the cookbook.

What changed (case 2 — cookbook did not have the content):
- Moved the Qwen3-Reranker and Qwen3-VL-Reranker launch commands, request/response
  formats, multimodal examples, and common pitfalls (~240 lines) out of
  rerank_models.mdx into two new cookbook pages:
    /cookbook/autoregressive/Qwen/Qwen3-Reranker
    /cookbook/autoregressive/Qwen/Qwen3-VL-Reranker
  rerank_models.mdx keeps the category-level cross-encoder guide, the supported
  models table (with model-name → cookbook links), and a short summary of the
  decoder-only rules.

Added the two new cookbook pages to docs.json navigation under the Qwen group.

Deliberately kept: the category-level quickstarts (client request examples,
Matryoshka embedding, multimodal embedding example, cross-encoder rerank
endpoint docs) are endpoint documentation rather than per-model duplication.

Refs #18427

Signed-off-by: Yancy <yancy@sglang.io>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 13, 2026
@Asthenia0412

Copy link
Copy Markdown
Author

Hi! The CI currently shows skipped jobs because this repo requires the run-ci label to trigger the full test suite. The failing jobs you see are just the CI gating placeholders (call-gate/pr-gate, pr-test-*-finish) — real tests haven't run yet.

Could someone please add the run-ci label to kick off the actual test matrix? Thanks so much! 🙏

@lm-sys @zhyncs @hnyls2002 @ispobock @BBuf @Fridge003 @kevin-mii

@hnyls2002

Copy link
Copy Markdown
Collaborator

Thanks for your interest in SGLang. This account opened 16 PRs in about eight hours, across unrelated subsystems (attention backends, speculative decoding, diffusion loading, scheduler IPC, KV-cache compression, docs), including two PRs for the same change (#44073 and #44117, both for #28808) and a fix for #43929 that is already on main. We can't review contributions at this volume, so we are closing the ones still open. If you want to pursue one, please pick a single change, verify it on a real run (a repro, a test, or numbers), and open a fresh PR.

@hnyls2002 hnyls2002 closed this Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants