vllm-project/vllm-omni

[Feature]: Auto-syncing example/*/*/README.md to docs/user_guide/examples/*/*.md

Open

#2,269 opened on Mar 27, 2026

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (1,067 forks)github user discovery
good first issuehelp wanted

Repository metrics

Stars
 (4,990 stars)
PR merge metrics
 (PR metrics pending)

Description

🚀 The feature, motivation and pitch

Currently, there are two copies of user guide docs in the codebase, as listed in title. A recent update of PR template gently request authors to sync changes to docs/user_guide using mkdoc commands before submitting the PR. A better solution can be a pre-commit hook the checks:

  • Whether the author edits docs/user_guide/examples in a commit, and abort this commit
  • When there is edit to examples, run mkdoc command

Downside: may need to disable this behavior when running pre-commit in CI. mkdoc takes a long time.

Open to discussions!

Alternatives

No response

Additional context

No response

Before submitting a new issue...

  • Make sure you already searched for relevant issues, and asked the chatbot living at the bottom right corner of the documentation page, which can answer lots of frequently asked questions.

Contributor guide

Research direction
Implement a pre commit hook that detects edits to examples/ and runs mkdoc to sync docs, while disabling the hook in CI to avoid long execution times.
Tech stack
pythonshell
Domain
documentationdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Gitpre commit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65