Skip to content

docs(i18n): complete Tier-2 must-haves for EPIC #5482 - #5793

Merged
Hmbown merged 4 commits into
codewhale-hq:mainfrom
SparkofSpike:docs/issue-5482-t2-mh
Sep 1, 2026
Merged

Hmbown merged 4 commits into
codewhale-hq:mainfrom
SparkofSpike:docs/issue-5482-t2-mh

Conversation

@SparkofSpike

Copy link
Copy Markdown
Contributor

Summary

This PR completes the Tier-2 must-haves for #5482 (EPIC: review, partially restructure, and fully localize documentation to Chinese).

It adds the remaining reviewed Simplified-Chinese translations under docs/zh_hans/, while leaving the already-landed GUIDE, INSTALL, and KEYBINDINGS translations out of this PR. It also removes the legacy .zh-CN.md redirect pages whose canonical documents now live in docs/zh_hans/.

Changes

  • Complete the remaining Tier-2 Chinese documentation: add Simplified-Chinese translations for:
    • AGENT_RUNTIME.md
    • CONFIGURATION.md
    • FLEET.md
    • HOOKS.md
    • MCP.md
    • MODES.md
    • PROVIDERS.md
    • SKILLS.md
    • SUBAGENTS.md
    • TELEMETRY.md
    • TOOL_LIFECYCLE.md
  • Preserve the existing Tier-2 translations: GUIDE.md, INSTALL.md, and KEYBINDINGS.md are already covered by earlier PRs and are intentionally not duplicated here.
  • Keep the canonical Chinese documentation layout: all translated documents use the docs/zh_hans/<name>.md layout while preserving the English filename stem.
  • Remove obsolete Chinese redirect pages: delete docs/LSP_PHP_CUSTOM.zh-CN.md and docs/WINDOWS_BEGINNER.zh-CN.md, since their canonical translations already exist under docs/zh_hans/.
  • Sync terminology with current English docs: the translations follow the rebased upstream documentation, including the current Pod/Fleet compatibility terminology and updated Runtime, provider, Fleet, sub-agent, MCP, hook, skill, and telemetry behavior.
  • Improve the Agent Runtime diagram: make the architecture diagram in docs/AGENT_RUNTIME.md look better.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Tests

Testing

Docs-only change: no Rust, web, or runtime code was modified, so the Cargo build, clippy, and test gates are not applicable.

What was verified instead:

  • Confirmed the branch was based on the latest fork main.

  • Compared the new Chinese documents against the current English source documents.

  • Confirmed that GUIDE.md, INSTALL.md, and KEYBINDINGS.md are not duplicated in this PR.

  • Confirmed the two removed .zh-CN.md files have canonical replacements under docs/zh_hans/.

  • Checked the staged diff with git diff --check.

  • Confirmed the final branch contains exactly the two intended documentation commits.

  • cargo fmt --all -- --check — N/A (docs-only)

  • cargo clippy --workspace --all-targets --all-features --locked — N/A (docs-only)

  • cargo test --workspace --all-features --locked — N/A (docs-only)

Checklist

  • Updated docs or comments as needed
  • Added or updated tests where relevant — N/A (docs-only)
  • Verified TUI behavior manually if UI changes — N/A
  • Harvested/co-authored credit uses a GitHub numeric noreply address — N/A

Related Issues

No-Issue: Part of #5482

@codewhale-agent codewhale-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codewhale reviewed the changed lines in this pull request. This is a comment-only review, not an approval.

Left 8 comments on changed lines.

{"blocker":8,"concern":0,"nit":0,"model":"skipped","policy":"default"}

Comment thread docs/zh_hans/PROVIDERS.md
provider = "deepseek"

[providers.deepseek]
api_key = "YOUR_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "openai"

[providers.openai]
api_key = "YOUR_GATEWAY_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "modelstudio-token-plan"

[providers.modelstudio_token_plan]
api_key = "YOUR_MODELSTUDIO_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "modelstudio-coding-plan"

[providers.modelstudio_coding_plan]
api_key = "YOUR_MODELSTUDIO_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "modelstudio-token-plan-anthropic"

[providers.modelstudio_token_plan_anthropic]
api_key = "YOUR_MODELSTUDIO_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "openrouter"

[providers.openrouter]
api_key = "sk-..."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/SUBAGENTS.md
provider = "deepseek"

[providers.deepseek]
api_key = "YOUR_DEEPSEEK_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/SUBAGENTS.md
[providers.lm-studio]
kind = "openai-compatible"
base_url = "http://127.0.0.1:1234/v1"
api_key = "lm-studio"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

@SparkofSpike

Copy link
Copy Markdown
Contributor Author

I've noticed that the English documentation has undergone some changes, especially FLEET.md, which has been significantly revised. However, I've been really busy lately and haven't been able to keep up.

I think I have no choice but to change my strategy—among this batch, a few pieces were indeed translated by AI. We have too many documents, and translating half of this PR manually has already drained all my energy. I plan to switch to a new mode: collaborating with an LLM, where it produces the first draft and I conduct rigorous reviews. That seems to be working better now.

Although some files haven't gone through a layperson's second review (like the examples I mentioned earlier—similar to black‑box testing and "老妪能解"), I've decided to go ahead and upload them; the longer I delay, the further behind I fall. Given the shortage of manpower, I'll prioritize making progress. As for translation quality, that remains a headache. Perhaps when I have more free time later, these issues will be resolved.

Next, I'll proceed with translating the Should‑haves and simultaneously correct the current translations. After all translations are completed, I will take full responsibility for this project—keeping it updated as much as I can and continuously ensuring translation quality.

@SparkofSpike
SparkofSpike marked this pull request as ready for review September 1, 2026 06:00
@SparkofSpike
SparkofSpike requested a review from Hmbown as a code owner September 1, 2026 06:00
Hmbown pushed a commit that referenced this pull request Sep 1, 2026
#5793 (14 files of zh-Hans documentation, +4868/-26) had no CI at all: only
Devin, GitGuardian and `gate` reported. Lint, the three Test legs and the npm
smoke never started, because an unlisted author's workflow runs sit at
`action_required` and never dispatch.

That is the failure AGENTS.md describes -- the PR looks abandoned when in fact
nobody has looked at it -- and it is worse for a translation contributor, who
gets silence rather than a review.

Signed-off-by: CodeWhale Bot <bot@codewhale.net>
@Hmbown Hmbown closed this Sep 1, 2026
@Hmbown Hmbown reopened this Sep 1, 2026
# Conflicts:
#	docs/AGENT_RUNTIME.md

@codewhale-agent codewhale-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codewhale reviewed the changed lines in this pull request. This is a comment-only review, not an approval.

Left 8 comments on changed lines.

{"blocker":8,"concern":0,"nit":0,"model":"skipped","policy":"default"}

Comment thread docs/zh_hans/PROVIDERS.md
provider = "deepseek"

[providers.deepseek]
api_key = "YOUR_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "openai"

[providers.openai]
api_key = "YOUR_GATEWAY_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "modelstudio-token-plan"

[providers.modelstudio_token_plan]
api_key = "YOUR_MODELSTUDIO_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "modelstudio-coding-plan"

[providers.modelstudio_coding_plan]
api_key = "YOUR_MODELSTUDIO_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "modelstudio-token-plan-anthropic"

[providers.modelstudio_token_plan_anthropic]
api_key = "YOUR_MODELSTUDIO_API_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/PROVIDERS.md
provider = "openrouter"

[providers.openrouter]
api_key = "sk-..."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/SUBAGENTS.md
provider = "deepseek"

[providers.deepseek]
api_key = "YOUR_DEEPSEEK_KEY"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Comment thread docs/zh_hans/SUBAGENTS.md
[providers.lm-studio]
kind = "openai-compatible"
base_url = "http://127.0.0.1:1234/v1"
api_key = "lm-studio"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker This changed line looks like a hardcoded secret.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants