Skip to content

docs(i18n): fix English doc inaccuracies and add first zh_hans translations for Tier-2 - #5613

Merged
Hmbown merged 5 commits into
Hmbown:mainfrom
SparkofSpike:codex/issue-5482-tier2-zh-docs
Aug 25, 2026
Merged

docs(i18n): fix English doc inaccuracies and add first zh_hans translations for Tier-2#5613
Hmbown merged 5 commits into
Hmbown:mainfrom
SparkofSpike:codex/issue-5482-tier2-zh-docs

Conversation

@SparkofSpike

@SparkofSpike SparkofSpike commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Review of the new Simplified-Chinese doc set under docs/zh_hans/ turned up
several places where the English source docs contradicted the codebase
(crates/config/src/provider_defaults.rs, crates/tui/src/child_env.rs,
crates/protocol/src/fleet.rs). This PR fixes those English-source
inaccuracies, adds cross-links from English docs to their Chinese counterparts,
and lands the first batch of Chinese translations: INSTALL, KEYBINDINGS, and
GUIDE — each synced against the current v0.9.11 English text, one commit per
document.

The remaining docs/zh_hans/ translations (AGENT_RUNTIME, CONFIGURATION,
FLEET, HOOKS, MCP, MODES, PROVIDERS, SKILLS, SUBAGENTS, TELEMETRY,
TOOL_LIFECYCLE) are not revied and intentionally kept out of this PR and
will land separately.

Changes

  • Ollama default model corrected: deepseek-coder:1.3bdeepseek-v4-flash
    in docs/PROVIDERS.md (3 rows) and docs/CONFIGURATION.md, matching
    DEFAULT_OLLAMA_MODEL in crates/config/src/provider_defaults.rs
  • HOOKS.md: condition rule count corrected from "Two rules" to "Three
    rules"; the shell_env parent allowlist description now lists proxy
    variables, color/terminal entries, and CARGO_HOME/RUSTUP_HOME entries and
    points to crates/tui/src/child_env.rs for the full list
  • GUIDE.md: first-launch install sentence now states that release
    installers expose the same runtime under codewhale and codew and that
    every install path ships the codewhale dispatcher with the codewhale-tui
    runtime built in
  • CHANGELOG_ARCHIVE.md: fixed a stale docs/INSTALL.md relative link
  • English docs: added > 阅读简体中文版 banner linking each translated
    doc to its zh_hans/ counterpart (15 files)
  • New Chinese translations (each in its own commit, synced to v0.9.11
    English):
    • docs/zh_hans/INSTALL.md — all install paths, v0.9.11 version bumps,
      new Omarchy/AUR and Shell completions sections, renumbered sections
    • docs/zh_hans/KEYBINDINGS.md — including the new Ctrl-Shift-U chord
    • docs/zh_hans/GUIDE.md — including the rewritten first-launch flow

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 code, config, or UI behavior was touched, so the
Cargo gates in CONTRIBUTING.md are not applicable.

What was verified instead:

  • Every technical assertion changed here was checked against the source:
    DEFAULT_OLLAMA_MODEL (provider_defaults.rs), the FleetWorkerAuth variant
    count (crates/protocol/src/fleet.rs), and the shell_env allowlist
    (crates/tui/src/child_env.rs)
  • Chinese translations were compared section-by-section against the English
    HEAD text: heading structure 1:1, version numbers, config keys, commands,
    and URLs all match; no sections missing and none added
  • Relative links inside docs/zh_hans/ use ..//../../ correctly for the
    deeper directory level

Checklist

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

Related Issues

No-Issue: Part of #5482 Tier-2 Must-haves

@SparkofSpike

Copy link
Copy Markdown
Contributor Author

The CI turning red isn't my fault – it's because the CI on the main branch is already failing. I'll leave it as is for now and check again later before I go to bed. I really have to bury myself in CONFIGURATION.md – it's way too long.

If the CI is still failing by the time I sleep, I'll just have to ask the maintainer to manually merge it.

@SparkofSpike
SparkofSpike marked this pull request as ready for review August 25, 2026 11:30
@SparkofSpike
SparkofSpike requested a review from Hmbown as a code owner August 25, 2026 11:30
@SparkofSpike

Copy link
Copy Markdown
Contributor Author

I've already got first drafts for the other files, but I haven't reviewed them yet. I need a bit more time to double‑check that they actually read well.

@Hmbown

Hmbown commented Aug 25, 2026

Copy link
Copy Markdown
Owner

Maintainer note — the Version drift red you saw was ours, not yours, and it is cleared now.

Your PR opened at 11:26:20 UTC and its drift check ran at 11:26:58. main was red on that gate at the time (a missing changelog receipt for #5604), and #5610 landed the fix at 11:31:00 — four minutes after your check ran. So you inherited a failure that had already been fixed by the time anyone looked at it.

Re-running the job alone didn't help, because a GitHub re-run replays the original event's merge SHA, which was still built on pre-fix main. I ran gh pr update-branch to rebuild the merge commit against current main.

Everything is green now — including all three Test lanes and Version drift. mergeStateStatus: CLEAN. Nothing for you to do.

Worth noting your Test (windows-latest) also went from red to green through this: #5610 fixed a Windows verbatim-path (\\?\C:\...) bug that was failing two tests on every open PR.

@SparkofSpike

Copy link
Copy Markdown
Contributor Author

OK, understood.

Just a quick note: I know you're very good at using AI to get work done, but I'd kindly ask that you don't rely on AI to review whether my translations are "reader‑friendly." From what I've seen, AI often degrades Chinese translations rather than improving them. I'd recommend limiting AI checks to semantics and prohibited‑word scans. For a proper language review, perhaps you could reach out to other native zh_hans speakers in the open‑source community.

@Hmbown
Hmbown merged commit 806d93e into Hmbown:main Aug 25, 2026
21 checks passed
Hmbown pushed a commit that referenced this pull request Aug 25, 2026
The #5613 cherry-pick sequence landed docs/zh_hans/INSTALL.md in 5e558a5
and then deleted it again in 7b11cb5 ("add zh_hans translation for
KEYBINDINGS"). Upstream's own KEYBINDINGS commit (582915f) only adds
docs/zh_hans/KEYBINDINGS.md; the deletion was an artifact of how the pick
was staged here, not anything the contributor did.

The file survived untracked in the working tree and is byte-identical to
5e558a5, so this restores it verbatim. Shizuku's translation is now
fully present on the integration branch, as #5613 intended.

Co-Authored-By: Grok 4.6 <noreply@anthropic.com>
@Hmbown

Hmbown commented Aug 25, 2026

Copy link
Copy Markdown
Owner

Summary

Review of the new Simplified-Chinese doc set under docs/zh_hans/ turned up

several places where the English source docs contradicted the codebase

(crates/config/src/provider_defaults.rs, crates/tui/src/child_env.rs,

crates/protocol/src/fleet.rs). This PR fixes those English-source

inaccuracies, adds cross-links from English docs to their Chinese counterparts,

and lands the first batch of Chinese translations: INSTALL, KEYBINDINGS, and

GUIDE — each synced against the current v0.9.11 English text, one commit per

document.

The remaining docs/zh_hans/ translations (AGENT_RUNTIME, CONFIGURATION,

FLEET, HOOKS, MCP, MODES, PROVIDERS, SKILLS, SUBAGENTS, TELEMETRY,

TOOL_LIFECYCLE) are not revied and intentionally kept out of this PR and

will land separately.

Changes

  • Ollama default model corrected: deepseek-coder:1.3bdeepseek-v4-flash

    in docs/PROVIDERS.md (3 rows) and docs/CONFIGURATION.md, matching

    DEFAULT_OLLAMA_MODEL in crates/config/src/provider_defaults.rs

  • HOOKS.md: condition rule count corrected from "Two rules" to "Three

    rules"; the shell_env parent allowlist description now lists proxy

    variables, color/terminal entries, and CARGO_HOME/RUSTUP_HOME entries and

    points to crates/tui/src/child_env.rs for the full list

  • GUIDE.md: first-launch install sentence now states that release

    installers expose the same runtime under codewhale and codew and that

    every install path ships the codewhale dispatcher with the codewhale-tui

    runtime built in

  • CHANGELOG_ARCHIVE.md: fixed a stale docs/INSTALL.md relative link

  • English docs: added > 阅读简体中文版 banner linking each translated

    doc to its zh_hans/ counterpart (15 files)

  • New Chinese translations (each in its own commit, synced to v0.9.11

    English):

    • docs/zh_hans/INSTALL.md — all install paths, v0.9.11 version bumps,

      new Omarchy/AUR and Shell completions sections, renumbered sections

    • docs/zh_hans/KEYBINDINGS.md — including the new Ctrl-Shift-U chord

    • docs/zh_hans/GUIDE.md — including the rewritten first-launch flow

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 code, config, or UI behavior was touched, so the

Cargo gates in CONTRIBUTING.md are not applicable.

What was verified instead:

  • Every technical assertion changed here was checked against the source:

    DEFAULT_OLLAMA_MODEL (provider_defaults.rs), the FleetWorkerAuth variant

    count (crates/protocol/src/fleet.rs), and the shell_env allowlist

    (crates/tui/src/child_env.rs)

  • Chinese translations were compared section-by-section against the English

    HEAD text: heading structure 1:1, version numbers, config keys, commands,

    and URLs all match; no sections missing and none added

  • Relative links inside docs/zh_hans/ use ..//../../ correctly for the

    deeper directory level

Checklist

  • Updated docs or comments as needed

  • Added or updated tests where relevant

  • Verified TUI behavior manually if UI changes

  • Harvested/co-authored credit uses a GitHub numeric noreply address

Related Issues

No-Issue: Part of #5482 Tier-2 Must-haves

Thank you so much for this!!

Hmbown pushed a commit that referenced this pull request Aug 29, 2026
…ntities

Twenty external contributions landed after the v0.9.11 band closed and none
were credited: the newest band in docs/CONTRIBUTORS.md was still v0.9.11 while
main shipped 0.9.12 work. Adds the v0.9.12 band covering all twenty (#5591,
#5599, #5604, #5610, #5613, #5621-#5624, #5629, #5650, #5657, #5669, #5682,
#5683, #5685, #5687, #5688, #5689, #5692) and demotes v0.9.11 so only the
newest band stays expanded.

AUTHOR_MAP gains numeric-noreply entries for musichen, M-Maciej, and serephus
so future harvested credit is graph-mappable, plus a comment recording that
wangfengcsu@qq.com (21 commits on main via #704) has no resolved login yet.

AUTHOR_MAP is a project convention consumed by scripts/check-coauthor-trailers.py
for new commits; GitHub does not read it, so it grants no retroactive
contribution-graph credit for history already on main.

No-Issue: contributor credit hygiene; no issue tracks it
Signed-off-by: CodeWhale Bot <bot@codewhale.net>
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