aboutsummaryrefslogtreecommitdiff
path: root/docs/dev-docs/pages/abouts
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-07-09 20:41:01 +0800
committer魏曹先生 <1992414357@qq.com>2026-07-09 20:57:25 +0800
commitcde98d144ef373012634c5be4dccca6d205791c3 (patch)
treeb92ad57dda31e72f954b6bc25ab76912a6aa7fb4 /docs/dev-docs/pages/abouts
parent9b8deaeced4f4a6f7c2492528019cc6e10c379ac (diff)
docs: add hero banners and unify page titles in dev-docs
Diffstat (limited to 'docs/dev-docs/pages/abouts')
-rw-r--r--docs/dev-docs/pages/abouts/ai-translation-rule.md111
-rw-r--r--docs/dev-docs/pages/abouts/code-verify-system.md5
2 files changed, 105 insertions, 11 deletions
diff --git a/docs/dev-docs/pages/abouts/ai-translation-rule.md b/docs/dev-docs/pages/abouts/ai-translation-rule.md
index cc33128..e880964 100644
--- a/docs/dev-docs/pages/abouts/ai-translation-rule.md
+++ b/docs/dev-docs/pages/abouts/ai-translation-rule.md
@@ -1,25 +1,116 @@
+<h1 align="center">AI Translation Rule</h1>
+<p align="center">
+ Translation prompt for your AI Agent
+</p>
+
# Translation Style Guide
## 1. Tone & Voice
-- **保持原语气** (Preserve original tone): Maintain the author's attitude, formality, and emotional register exactly as in the source.
-- **近似词替换** (Synonymous substitution): Use words with close or equivalent meaning where direct translation is awkward or unnatural.
+### Preserve original tone
+
+Maintain the author's attitude, formality, and emotional register exactly as in the source.
+
+### Synonymous substitution
+
+Use words with close or equivalent meaning where direct translation is awkward or unnatural.
## 2. Vocabulary & Abbreviation
-- **缩写** (Abbreviation): Apply standard English abbreviations (e.g., _info_ for information, _dept_ for department) to avoid overlong words, but only when clarity is not sacrificed.
-- **简明表述** (Concise expression): Prefer shorter, more common alternatives (e.g., _use_ over _utilize_, _help_ over _facilitate_) unless the original tone demands formality.
+### Abbreviation
+
+Apply standard English abbreviations (e.g., _info_ for information, _dept_ for department)
+to avoid overlong words,
+but only when clarity is not sacrificed.
+
+### Concise expression
+
+Prefer shorter, more common alternatives (e.g., _use_ over _utilize_, _help_ over _facilitate_)
+unless the original tone demands formality.
## 3. Structural Rules
-- **段落一致** (Paragraph integrity): Keep the original paragraph breaks and line spacing.
-- **标记保留** (Tag preservation): Any inline Markdown formatting (bold, italic, code, links, lists) must be replicated exactly in translation.
-- **例示** (Example):
- - 原句: “请保持专业语气,但避免使用过长的学术词汇。”
- - 译文: “Keep a prof. tone, but avoid long academic words.”
-- **最小化改动** (Minimal diff): When translating or syncing English content against a known Chinese original, if the Chinese original's meaning is extremely close to the current English meaning, do not modify the English text. This is to keep git diffs friendly (only modify parts that have truly changed).
+### Paragraph integrity
+
+Keep the original paragraph breaks and line spacing.
+
+### Tag preservation
+
+Any inline Markdown formatting (bold, italic, code, links, lists) must be replicated exactly in translation.
+
+### Example
+
+- Before: “请保持专业语气,但避免使用过长的学术词汇。”
+- After: “Keep a prof. tone, but avoid long academic words.”
+
+### Minimal diff
+
+When translating or syncing English content against a known Chinese original,
+if the Chinese original's meaning is extremely close to the current English meaning,
+do not modify the English text.
+This is to keep git diffs friendly _(only modify parts that have truly changed)_.
## 4. Exceptions
- If a term has no common abbreviation, use the full word.
- If preserving tone requires a longer phrase, prioritize tone over brevity.
+
+## 5. Original Text
+
+```markdown
+# Translation Style Guide
+
+## 1. Tone & Voice
+
+### Preserve original tone
+
+Maintain the author's attitude, formality, and emotional register exactly as in the source.
+
+### Synonymous substitution
+
+Use words with close or equivalent meaning where direct translation is awkward or unnatural.
+
+## 2. Vocabulary & Abbreviation
+
+### Abbreviation
+
+Apply standard English abbreviations (e.g., _info_ for information, _dept_ for department)
+to avoid overlong words,
+but only when clarity is not sacrificed.
+
+### Concise expression
+
+Prefer shorter, more common alternatives (e.g., _use_ over _utilize_, _help_ over _facilitate_)
+unless the original tone demands formality.
+
+## 3. Structural Rules
+
+### Paragraph integrity
+
+Keep the original paragraph breaks and line spacing.
+
+### Tag preservation
+
+Any inline Markdown formatting (bold, italic, code, links, lists) must be replicated exactly in translation.
+
+### Example
+
+- Before: “请保持专业语气,但避免使用过长的学术词汇。”
+- After: “Keep a prof. tone, but avoid long academic words.”
+
+### Minimal diff
+
+When translating or syncing English content against a known Chinese original,
+if the Chinese original's meaning is extremely close to the current English meaning,
+do not modify the English text.
+This is to keep git diffs friendly _(only modify parts that have truly changed)_.
+
+## 4. Exceptions
+
+- If a term has no common abbreviation, use the full word.
+- If preserving tone requires a longer phrase, prioritize tone over brevity.
+```
+
+<p align="center" style="font-size: 0.85em; color: gray;">
+ Written by @Weicao-CatilGrass
+</p>
diff --git a/docs/dev-docs/pages/abouts/code-verify-system.md b/docs/dev-docs/pages/abouts/code-verify-system.md
index 7694544..59b98cb 100644
--- a/docs/dev-docs/pages/abouts/code-verify-system.md
+++ b/docs/dev-docs/pages/abouts/code-verify-system.md
@@ -1,4 +1,7 @@
-# Doc Code Block Verification System
+<h1 align="center">Markdown Code Verification System</h1>
+<p align="center">
+ A system that verifies every identified code block can be compiled
+</p>
This system automatically extracts and compiles Rust code blocks from docs, ensuring all example code stays usable in CI.