Doc Writer

Documentation Writer

Write bilingual VitePress documentation for the Relax project, ensuring both format correctness and content correctness.

Three Inviolable Rules

1. Bilingual requirement — EVERY documentation page MUST be created in BOTH English (docs/guide/) AND Chinese (docs/zh/guide/) simultaneously. Never create only one language version. Both versions must have identical structure and content coverage.
2. Format correctness — every doc page must exist in both docs/guide/ (English) and docs/zh/guide/ (Chinese), be registered in docs/.vitepress/config.mts sidebar, and follow the established Markdown conventions.
3. Content correctness — every API, class, function, config option, and CLI flag mentioned in the doc must be verified against the current source code. Never invent features, never describe removed/renamed APIs, never guess parameter names.

Workflow

Step 0: Check if this is a draft document

IMPORTANT: If the user is working on a document in docs/draft/, this skill should NOT be invoked unless the user explicitly says they want to "publish" or "release" the draft.

• Documents in docs/draft/ are temporary/work-in-progress documents
• Users can freely create, edit, and iterate on drafts without triggering this skill's strict bilingual and verification requirements
• Only when the user explicitly requests to publish/release a draft (e.g., "publish this draft", "move this to the official docs", "release the draft documentation") should you proceed with the full workflow below

If the current task involves a draft document and the user has NOT requested publication, politely decline and suggest they can continue working on the draft freely, or ask if they want to publish it.

Step 1: Determine scope

Ask (or infer from user request):

• Topic: which module or feature to document (e.g., "checkpoint engine", "notification system")
• Category: where it belongs in the sidebar (Getting Started, Core Concepts, Advanced, Development, or Examples)
• Filename: kebab-case, e.g., checkpoint-engine.md

Step 2: Verify content against source code

Before writing a single line of documentation, read the actual source code for the feature being documented. Required steps:

1. Identify relevant source files — search relax/, transfer_queue/, examples/ for the module.
2. Read public APIs — list all classes, functions, and their actual signatures (parameter names, types, defaults).
3. Read config/arguments — check relax/utils/arguments.py or the relevant argument parser for CLI flags.
4. Check imports — verify that import paths shown in code examples are correct (e.g., from relax.metrics import MetricsClient).
5. Check existing docs — read any related existing docs to avoid contradictions.

Critical: If the source code differs from what the user describes, trust the source code and note the discrepancy.

Step 3: Write BOTH English and Chinese docs

CRITICAL: You MUST create BOTH language versions in the same session. Never create only one version. CRITICAL: ASCII art diagrams (box-drawing characters ┌┐└┘ forming rectangular boxes) must ALWAYS use English text, even in Chinese docs. Never translate text inside box-drawing diagrams to Chinese.

Step 3a: Write English doc

Create docs/guide/<filename>.md (or docs/examples/<filename>.md, docs/api/<filename>.md depending on category).

Follow the doc template in references/doc-template.md.

Key rules:

• Title is an H1 (#) matching the feature name
• Use standard section order: Overview → Architecture (if applicable) → Features → Quick Start → Configuration → API Reference → Usage Examples → Best Practices → Troubleshooting → Next Steps
• Not every section is required — omit sections that don't apply
• Code examples must use real import paths and real function signatures from Step 2
• Architecture diagrams use ASCII art (box drawing characters: ┌ ─ ┐ │ └ ┘ ▼ ▲ ► ◄)
• Use VitePress containers: ::: tip, ::: warning, ::: danger
• Cross-reference other docs with relative links: [Architecture](./architecture.md)
• End with "Next Steps" linking to 2-3 related docs

Step 3b: Write Chinese doc (MANDATORY)

Immediately after creating the English doc, create the Chinese counterpart at docs/zh/guide/<filename>.md (or corresponding zh/ path).

Translation rules:

• Translate ALL prose text to Chinese
• Keep code blocks, CLI commands, variable names, class names unchanged
• Translate code comments inside code blocks to Chinese
• Keep technical terms that are widely used in English as-is (e.g., "Ray Serve", "TensorBoard", "checkpoint") — no forced translation
• Section headers must be natural Chinese (e.g., "Overview" → "概述", "Quick Start" → "快速开始", "Configuration" → "配置", "Best Practices" → "最佳实践", "Troubleshooting" → "故障排除", "Next Steps" → "下一步")
• Chinese doc must cover the exact same sections and content as the English doc — no missing sections, no extra sections

Verification: Before proceeding to Step 4, confirm that BOTH docs/guide/<filename>.md AND docs/zh/guide/<filename>.md have been created.

Step 4: Register in VitePress config

Edit docs/.vitepress/config.mts:

1. Add to the English sidebar under the correct group
2. Add to the Chinese sidebar under the corresponding Chinese group
3. Both entries must use correct link paths (/guide/<filename> and /zh/guide/<filename>)

English sidebar group mapping:

Chinese sidebar group mapping:

Step 5: Verify

After creating both docs and updating config:

1. Verify both language versions exist — confirm BOTH docs/guide/<filename>.md AND docs/zh/guide/<filename>.md have been created. If only one exists, immediately create the missing version.
2. Cross-check code examples — re-read the source files and confirm every import path, class name, and function signature in the doc matches the code.
3. Check bilingual parity — confirm both docs have the same sections in the same order, with identical content coverage.
4. Check sidebar config — confirm both English and Chinese entries are added to config.mts.
5. Check internal links — any [text](./other-doc.md) references must point to docs that actually exist.
6. Check repository paths — scan the doc for every file/directory path that references the repo (e.g., relax/utils/health_system.py, scripts/models/qwen3-4B.sh). For each path, verify the file or directory actually exists. Remove or correct any stale/wrong paths.

Content Verification Checklist

When writing docs, verify each of these against the source code:

• Bilingual completeness — BOTH English (docs/guide/) AND Chinese (docs/zh/guide/) versions exist with identical structure
• Import paths — from relax.xxx import YYY must match actual __init__.py exports
• Class names — must match actual class definitions
• Function signatures — parameter names, types, and defaults must match source
• CLI arguments — --flag-name must exist in the argument parser
• Config keys — YAML config keys must match what the code actually reads
• Default values — stated defaults must match source code defaults
• Architecture claims — "uses Ray Serve", "deployed as actor" etc. must be true
• Feature claims — don't say "supports X" if X is not implemented
• Repository paths — every file or directory path mentioned in the doc (e.g., relax/utils/metrics/client.py, configs/env.yaml, scripts/training/basic/run-qwen3-4B-8xgpu.sh) must actually exist in the repo. Run ls or read_file to confirm before including any path. This includes paths in prose text, code block comments, tables, and architecture diagrams

If you cannot verify something (e.g., the code is ambiguous or the feature is partially implemented), explicitly mark it in the doc with a ::: warning block.

Project Structure Reference

docs/
├── .vitepress/
│   └── config.mts              # Sidebar & nav config (MUST update for new pages)
├── guide/                      # English guides
├── zh/guide/                   # Chinese guides (mirror of guide/)
├── api/                        # English API docs
├── zh/api/                     # Chinese API docs
├── examples/                   # English example docs
├── zh/examples/                # Chinese example docs
└── index.md / zh/index.md      # Home pages

Source code locations for verification:

relax/                          # Core framework
├── core/                       # Controller & service base classes
├── components/                 # Ray Serve deployments (actor, critic, rollout, genrm)
├── engine/                     # Rollout, rewards, filters, router
├── backends/                   # Megatron, SGLang, FSDP backends
├── distributed/                # Ray actor utilities, checkpoint service
├── entrypoints/                # Training entry scripts (train.py)
└── utils/                      # Utilities (arguments, metrics, logging, etc.)

transfer_queue/                 # Data transfer queue system
examples/                       # User-level examples (deepeyes, OPD, etc.)
scripts/                        # Launch scripts
configs/                        # Runtime env config (env.yaml)

Section Header Translation Reference

References

• references/doc-template.md — Standard doc page template (English + Chinese)
• references/content-verification-guide.md — Detailed guide on verifying doc content against source code