vllm-project/vllm-omni
[Feature]: Auto-syncing example/*/*/README.md to docs/user_guide/examples/*/*.md
Ouverte
#2 269 ouverte le 27 mars 2026
good first issuehelp wanted
Métriques du dépôt
- Stars
- (4 990 étoiles)
- Métriques de merge PR
- (Métriques PR en attente)
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/examplesin 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.