From 862bd8143cccfea612a9cda2cce83e81b2638019 Mon Sep 17 00:00:00 2001
From: herizhen <59841270+herizhen@users.noreply.github.com>
Date: Tue, 21 Apr 2026 16:33:43 +0800
Subject: [PATCH] [Releases/v0.18.0][Doc][Misc] Added version description in
 the writing template (#8451)

### 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>
---
 docs/source/_templates/Model-Deployment-Tutorial-Template.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/source/_templates/Model-Deployment-Tutorial-Template.md b/docs/source/_templates/Model-Deployment-Tutorial-Template.md
index bf6d1b36..d13e39f8 100644
--- a/docs/source/_templates/Model-Deployment-Tutorial-Template.md
+++ b/docs/source/_templates/Model-Deployment-Tutorial-Template.md
@@ -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