EngineX/xc-llm-ascend
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[Releases/v0.18.0][Doc][Misc] Added version description in the writing template (#8451)

Browse Source 
### What this PR does / why we need it?
This PR updates the model deployment tutorial template to include a
requirement for authors to add a comment when code examples contain
version numbers. This ensures that users are prompted to use the version
appropriate for their specific environment.

### Does this PR introduce _any_ user-facing change?
No.

### How was this patch tested?
N/A (Documentation change)

---------

Signed-off-by: herizhen <1270637059@qq.com>
Signed-off-by: herizhen <59841270+herizhen@users.noreply.github.com>
This commit is contained in:
herizhen
2026-04-21 16:33:43 +08:00
committed by GitHub
parent 7850264324
commit 862bd8143c
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/_templates/Model-Deployment-Tutorial-Template.md
View File

@@ -75,6 +75,7 @@ If multi-node deployment is required, please follow the [Verify Multi-node Commu
- Provide specific steps and startup commands, covering both single-node and multi-node configurations.
- Provide explanations for parameters, including meaning, value range, and units.
- Specify the basic environment variables and communication environment variables that need to be enabled, with explanations including meaning, value range, and units.
- If the code example includes version numbers, it is necessary to add a comment explaining that the version number should be filled in according to the actual version in use.
### 4.1 Docker Image Installation