[Doc] Clean up contributing guide navigation

docs/source/developer_guide/contribution/contributing.md

@@ -1,12 +1,13 @@
-# Contributing
+# Pull Request Workflow
 
 ## Building and Testing
-It's recommended to set up a local development environment to build vllm-kunlun and run tests
+
+It's recommended to set up a local development environment to build vLLM-Kunlun and run tests
 before you submit a PR.
 
 ### Run models locally
 
-After completing Run lint setup which is shown in quicksatrt, you can run your changed locally:
+After completing the setup shown in Quick Start, you can run your changes locally:
 
 ```{code-block} bash
    :substitutions:
@@ -29,16 +30,19 @@ python -m vllm.entrypoints.openai.api_server \
       --served-model-name your_modified_models
 ```
 
-Please save a screenshot of your service running successfully, and attach an accuracy report.
+Save evidence that the service runs successfully, and attach an accuracy report
+when your change affects model behavior.
 
 ### Submit the commit
 
+Use `-s` to add the required DCO sign-off to your commit.
+
 ```bash
 # Commit changed files using `-s`
 git commit -sm "your commit info"
 ```
 
-🎉 Congratulations! You have completed the development environment setup.
+Congratulations! You have completed the development environment setup.
 
 ## PR Title and Classification
 
@@ -49,7 +53,7 @@ Only specific types of PRs will be reviewed. The PR title is prefixed appropriat
 - `[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)
+- `[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.

docs/source/developer_guide/contribution/index.md

@@ -1,67 +1,14 @@
-# Contributing
+# Contribution Guide
 
-## Building and Testing
+Use this section to prepare a vLLM-Kunlun contribution, validate your changes,
+and submit a pull request with the required metadata.
 
-It's recommended to set up a local development environment to build vllm-kunlun and run tests
-before you submit a PR.
-
-### Run models locally
-
-After completing Run lint setup which is shown in quicksatrt, you can run your changed locally:
-
-```{code-block} bash
-   :substitutions:
-
-python -m vllm.entrypoints.openai.api_server \
-      --host 0.0.0.0 \
-      --port 8356 \
-      --model /your_modified_models\
-      --trust-remote-code \
-      --tensor-parallel-size 1 \
-      --no-enable-prefix-caching \
-      --no-enable-chunked-prefill \
-      --distributed-executor-backend mp \
-      --served-model-name your_modified_models
-```
-
-Please save a screenshot of your service running successfully, and attach an accuracy report.
-
-### Submit the commit
-
-```bash
-# Commit changed files using `-s`
-git commit -sm "your commit info"
-```
-
-🎉 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.
+Start with the pull request workflow for the current build, test, PR title, and
+DCO requirements.
 
 :::{toctree}
-:caption: Index
+:caption: Contribution Topics
 :maxdepth: 1
+
 contributing
 :::