From c385dcf15930d2754b68c2794986ad30fc65c141 Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Mon, 20 Jul 2026 09:50:28 +0800
Subject: docs: migrate renderer examples to buffer macro and update docs

Update all documentation and code examples to use the new
`#[renderer(buffer)]`
pattern with `r_println!` instead of manually constructing
`RenderResult`
with `writeln!`.
---
 docs/_zh_CN/pages/10-help.md | 26 ++++++++++++--------------
 1 file changed, 12 insertions(+), 14 deletions(-)

(limited to 'docs/_zh_CN/pages/10-help.md')

diff --git a/docs/_zh_CN/pages/10-help.md b/docs/_zh_CN/pages/10-help.md
index 8cee2aa..1c4e410 100644
--- a/docs/_zh_CN/pages/10-help.md
+++ b/docs/_zh_CN/pages/10-help.md
@@ -13,18 +13,17 @@ Mingling 里用 `#[help]` 宏给命令添加帮助文本。
 
 ```rust
 @@@use mingling::macros::help;
+@@@use mingling::macros::buffer;
 @@@dispatcher!("greet", CMDGreet => EntryGreet);
-#[help]
-fn help_greet(_entry: EntryGreet) -> RenderResult {
-    let mut r = RenderResult::new();
-    writeln!(r, "Usage: greet [name]").ok();
-    writeln!(r, "Say hello to someone.").ok();
-    r
+#[help(buffer)]
+fn help_greet(_entry: EntryGreet) {
+    r_println!("Usage: greet [name]");
+    r_println!("Say hello to someone.");
 }
 ```
  
 > [!NOTE]
-> 帮助函数同样通过 `writeln!` 向 `RenderResult` 写入内容，因为 `#[help]` 遵循渲染管线 —— 它是由 `--help` 标志提前触发的短路渲染，而不是管线之外的逻辑。
+> 帮助函数同样通过 `r_println!` 向 `RenderResult` 写入内容，因为 `#[help]` 遵循渲染管线 —— 它是由 `--help` 标志提前触发的短路渲染，而不是管线之外的逻辑。
 
 ## 全局帮助
 
@@ -32,14 +31,13 @@ fn help_greet(_entry: EntryGreet) -> RenderResult {
 
 ```rust
 @@@use mingling::macros::help;
+@@@use mingling::macros::buffer;
 // 用户直接输入 --help 时触发
-#[help]
-fn help_root(entry: ErrorDispatcherNotFound) -> RenderResult {
-    let mut r = RenderResult::new();
-    writeln!(r, "Usage: my-cli <command>").ok();
-    writeln!(r, "Commands:").ok();
-    writeln!(r, "  greet    Say hello").ok();
-    r
+#[help(buffer)]
+fn help_root(entry: ErrorDispatcherNotFound) {
+    r_println!("Usage: my-cli <command>");
+    r_println!("Commands:");
+    r_println!("  greet    Say hello");
 }
 ```
  
-- 
cgit