[Doc] Clean up contributing guide navigation#349
Open
Lidang-Jiang wants to merge 1 commit into
Open
Conversation
Signed-off-by: Lidang Jiang <lidangjiang@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
contributing.mdand clarify DCO sign-off guidance.Before
Please save a screenshot of your service running successfully, and attach an accuracy report.
Submit the commit
🎉 Congratulations! You have completed the development environment setup.
PR Title and Classification
Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:
[Attention]for new features or optimization in attention.[Communicator]for new features or optimization in communicators.[ModelRunner]for new features or optimization in model runner.[Platform]for new features or optimization in platform.[Worker]for new features or optimization in worker.[Core]for new features or optimization in the core vllm-kunlun logic (such as platform, attention, communicators, model runner)[Kernel]for changes affecting compute kernels and ops.[Bugfix]for bug fixes.[Doc]for documentation fixes and improvements.[Test]for tests (such as unit tests).[CI]for build or continuous integration improvements.[Misc]for PRs that do not fit the above categories. Please use this sparingly.:::{note}
If the PR spans more than one category, please include all relevant prefixes.
:::
Others
If you find any problem when contributing, you can join our slack group to talk with us and then feel free to submit a PR to improve the doc to help other developers.
:::{toctree}
:caption: Index
:maxdepth: 1
contributing
:::
Save evidence that the service runs successfully, and attach an accuracy report
when your change affects model behavior.
Submit the commit
Use
-sto add the required DCO sign-off to your commit.Congratulations! You have completed the development environment setup.
PR Title and Classification
Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:
[Attention]for new features or optimization in attention.[Communicator]for new features or optimization in communicators.[ModelRunner]for new features or optimization in model runner.[Platform]for new features or optimization in platform.[Worker]for new features or optimization in worker.[Core]for new features or optimization in the core vLLM-Kunlun logic (such as platform, attention, communicators, model runner)[Kernel]for changes affecting compute kernels and ops.[Bugfix]for bug fixes.[Doc]for documentation fixes and improvements.[Test]for tests (such as unit tests).[CI]for build or continuous integration improvements.[Misc]for PRs that do not fit the above categories. Please use this sparingly.:::{note}
If the PR spans more than one category, please include all relevant prefixes.
:::
Others
If you find any problem when contributing, you can join our slack group to talk with us and then feel free to submit a PR to improve the doc to help other developers.
$ git diff --check origin/main..HEAD
$ PYTHONWARNINGS=ignore::UserWarning sphinx-build -b dummy -n -W --keep-going docs/source /tmp/vllm-kunlun-docs-contribution-pr-dummy
Running Sphinx v8.1.3
loading translations [en]... done
making output directory... done
[autosummary] generating autosummary for: community/contributors.md, community/governance.md, community/user_stories/index.md, community/versioning_policy.md, developer_guide/contribution/contributing.md, developer_guide/contribution/index.md, developer_guide/evaluation/accuracy/accuracy_kernel.md, developer_guide/evaluation/accuracy/accuracy_server.md, developer_guide/evaluation/accuracy/index.md, developer_guide/evaluation/accuracy_report/GLM-4.5-Air.md, ..., user_guide/configuration/env_vars.md, user_guide/configuration/index.md, user_guide/feature_guide/graph_mode.md, user_guide/feature_guide/index.md, user_guide/feature_guide/lora.md, user_guide/feature_guide/quantization.md, user_guide/release_notes.md, user_guide/support_matrix/index.md, user_guide/support_matrix/supported_features.md, user_guide/support_matrix/supported_models.md
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'substitution', 'colon_fence'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=5, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={vllm_version: ..., vllm_kunlun_version: ..., pip_vllm_kunlun_version: ..., pip_vllm_version: ..., ci_vllm_version: ...}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [dummy]: targets for 45 source files that are out of date
updating environment: [new config] 45 added, 0 changed, 0 removed
reading sources... [ 2%] community/contributors
reading sources... [ 4%] community/governance
reading sources... [ 7%] community/user_stories/index
reading sources... [ 9%] community/versioning_policy
reading sources... [ 11%] developer_guide/contribution/contributing
reading sources... [ 13%] developer_guide/contribution/index
reading sources... [ 16%] developer_guide/evaluation/accuracy/accuracy_kernel
reading sources... [ 18%] developer_guide/evaluation/accuracy/accuracy_server
reading sources... [ 20%] developer_guide/evaluation/accuracy/index
reading sources... [ 22%] developer_guide/evaluation/accuracy_report/GLM-4.5
reading sources... [ 24%] developer_guide/evaluation/accuracy_report/GLM-4.5-Air
reading sources... [ 27%] developer_guide/evaluation/accuracy_report/InternVL3_5-30B-A3B
reading sources... [ 29%] developer_guide/evaluation/accuracy_report/Qwen2.5-VL-7B-Instruct
reading sources... [ 31%] developer_guide/evaluation/accuracy_report/index
reading sources... [ 33%] developer_guide/evaluation/index
reading sources... [ 36%] developer_guide/feature_guide/Kunlun_Graph
reading sources... [ 38%] developer_guide/feature_guide/index
reading sources... [ 40%] developer_guide/performance/index
reading sources... [ 42%] developer_guide/performance/performance_benchmark/benchmark_kernel
reading sources... [ 44%] developer_guide/performance/performance_benchmark/benchmark_server
reading sources... [ 47%] developer_guide/performance/performance_benchmark/index
reading sources... [ 49%] developer_guide/performance/performance_benchmark/profiling
reading sources... [ 51%] faqs
reading sources... [ 53%] index
reading sources... [ 56%] installation
reading sources... [ 58%] quick_start
reading sources... [ 60%] tutorials/index
reading sources... [ 62%] tutorials/multi_xpu_DeepSeek-V3.2-Exp-w8a8
reading sources... [ 64%] tutorials/multi_xpu_GLM-4.5
reading sources... [ 67%] tutorials/multi_xpu_GLM-5-W8A8-INT8
reading sources... [ 69%] tutorials/multi_xpu_Qwen2.5-VL-32B
reading sources... [ 71%] tutorials/multi_xpu_Qwen3-Coder-480B-A35B(W8A8)
reading sources... [ 73%] tutorials/single_xpu_InternVL2_5-26B
reading sources... [ 76%] tutorials/single_xpu_Qwen3-8B
reading sources... [ 78%] tutorials/single_xpu_Qwen3-VL-32B
reading sources... [ 80%] user_guide/configuration/env_vars
reading sources... [ 82%] user_guide/configuration/index
reading sources... [ 84%] user_guide/feature_guide/graph_mode
reading sources... [ 87%] user_guide/feature_guide/index
reading sources... [ 89%] user_guide/feature_guide/lora
reading sources... [ 91%] user_guide/feature_guide/quantization
reading sources... [ 93%] user_guide/release_notes
reading sources... [ 96%] user_guide/support_matrix/index
reading sources... [ 98%] user_guide/support_matrix/supported_features
reading sources... [100%] user_guide/support_matrix/supported_models
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying assets: done
writing output... [ 2%] community/contributors
writing output... [ 4%] community/governance
writing output... [ 7%] community/user_stories/index
writing output... [ 9%] community/versioning_policy
writing output... [ 11%] developer_guide/contribution/contributing
writing output... [ 13%] developer_guide/contribution/index
writing output... [ 16%] developer_guide/evaluation/accuracy/accuracy_kernel
writing output... [ 18%] developer_guide/evaluation/accuracy/accuracy_server
writing output... [ 20%] developer_guide/evaluation/accuracy/index
writing output... [ 22%] developer_guide/evaluation/accuracy_report/GLM-4.5
writing output... [ 24%] developer_guide/evaluation/accuracy_report/GLM-4.5-Air
writing output... [ 27%] developer_guide/evaluation/accuracy_report/InternVL3_5-30B-A3B
writing output... [ 29%] developer_guide/evaluation/accuracy_report/Qwen2.5-VL-7B-Instruct
writing output... [ 31%] developer_guide/evaluation/accuracy_report/index
writing output... [ 33%] developer_guide/evaluation/index
writing output... [ 36%] developer_guide/feature_guide/Kunlun_Graph
writing output... [ 38%] developer_guide/feature_guide/index
writing output... [ 40%] developer_guide/performance/index
writing output... [ 42%] developer_guide/performance/performance_benchmark/benchmark_kernel
writing output... [ 44%] developer_guide/performance/performance_benchmark/benchmark_server
writing output... [ 47%] developer_guide/performance/performance_benchmark/index
writing output... [ 49%] developer_guide/performance/performance_benchmark/profiling
writing output... [ 51%] faqs
writing output... [ 53%] index
writing output... [ 56%] installation
writing output... [ 58%] quick_start
writing output... [ 60%] tutorials/index
writing output... [ 62%] tutorials/multi_xpu_DeepSeek-V3.2-Exp-w8a8
writing output... [ 64%] tutorials/multi_xpu_GLM-4.5
writing output... [ 67%] tutorials/multi_xpu_GLM-5-W8A8-INT8
writing output... [ 69%] tutorials/multi_xpu_Qwen2.5-VL-32B
writing output... [ 71%] tutorials/multi_xpu_Qwen3-Coder-480B-A35B(W8A8)
writing output... [ 73%] tutorials/single_xpu_InternVL2_5-26B
writing output... [ 76%] tutorials/single_xpu_Qwen3-8B
writing output... [ 78%] tutorials/single_xpu_Qwen3-VL-32B
writing output... [ 80%] user_guide/configuration/env_vars
writing output... [ 82%] user_guide/configuration/index
writing output... [ 84%] user_guide/feature_guide/graph_mode
writing output... [ 87%] user_guide/feature_guide/index
writing output... [ 89%] user_guide/feature_guide/lora
writing output... [ 91%] user_guide/feature_guide/quantization
writing output... [ 93%] user_guide/release_notes
writing output... [ 96%] user_guide/support_matrix/index
writing output... [ 98%] user_guide/support_matrix/supported_features
writing output... [100%] user_guide/support_matrix/supported_models
build succeeded.
The dummy builder generates no files.