Skip to content

docs: add unofficial notice; sync Chinese README version requirement and Development section - #118

Merged
7678837-glitch merged 2 commits into
xjoker:devfrom
7678837-glitch:docs/unofficial-disclaimer-cn-dev
Oct 19, 2026
Merged

7678837-glitch merged 2 commits into
xjoker:devfrom
7678837-glitch:docs/unofficial-disclaimer-cn-dev

Conversation

@7678837-glitch

@7678837-glitch 7678837-glitch commented Oct 19, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Docs-only change to the READMEs.

  • Add a short notice to README.md and README_CN.md: codex-switch is an unofficial tool, not affiliated with or endorsed by OpenAI.
  • Version sentence (line 48 in both files after this revision): both languages now say the same thing, and it matches the code. codex-switch launch requires Codex 0.159.2 or newer (the support minimum); versions newer than the 0.162.1 alignment baseline are accepted but not fully verified. I checked this against src/codex_compat.rs on dev:
    • MINIMUM_CODEX_VERSION = "0.159.2" and ALIGNED_CODEX_VERSION = "0.162.1".
    • ensure_launch_version bails when the detected version is below the minimum.
    • A version newer than the baseline is reported as AboveBaselineUnverified and is allowed.
    • Not covered in the README (the Wiki documents them): an unknown version only warns, and local dev builds skip the check.
  • README_CN.md: add a 开发 section that matches README.md → Development. It covers Rust 1.88+ (from Cargo.toml rust-version), the same three cargo commands and the same two Wiki links.
  • Language links: English is the primary README, and README_CN.md is the supporting translation. These are two separate files, and I did not rename README_CN.md. Each file now has a link line at the top: English | [简体中文](README_CN.md) in README.md, and [English](README.md) | 简体中文 in README_CN.md, followed by a note that the English version is authoritative. The old inline 中文说明 / English README links on line 5 were folded into the new line. The Wiki and Releases links on that line stay.

This PR targets dev, as CONTRIBUTING.md asks.

Revision 2 (review follow-up, commit 129701a)

  • README.md:48: "The support minimum remains 0.159.2" is replaced by the sentence above, so English and Chinese now say the same thing.
  • Added the top-of-file language links in both files, plus the authoritative-English note in README_CN.md.

Files

  • README.md
  • README_CN.md

Testing

Docs only. No code, config or workflow changed, so I did not run end-to-end or real-account tests. Checks on this branch after revision 2:

  • Relative link and anchor check on README.md and README_CN.md: 19 relative links, 0 broken. This includes the new README.md ↔ README_CN.md links.
  • Wiki home, Chinese-Guide, Developer-Onboarding, Architecture-Overview and Releases all return HTTP 200.
  • cargo +1.99.0 test --locked --test test_distribution_contract (this test reads both READMEs): 36 passed, 0 failed.
  • gitleaks on the new commit: no leaks.
  • Not run locally: full cargo clippy / cargo test --all / cargo audit and the macOS/Windows matrix. They don't depend on README content. PR CI (run 39206549496) started on this head: Format and audit passed; the Linux, macOS and Windows test jobs were still running when I last checked.

7678837-glitch and others added 2 commits October 19, 2026 13:10
- README.md: state the minimum the same way README_CN.md does and the code
  enforces it: `codex-switch launch` requires Codex 0.159.2 or newer (the
  support minimum); newer than the 0.162.1 alignment baseline is accepted
  but not fully verified (src/codex_compat.rs MINIMUM/ALIGNED constants,
  ensure_launch_version bails below the minimum).
- Both READMEs: one language link line at the top; README_CN.md is marked
  as a translation with the English version authoritative. The old
  inline "中文说明" / "English README" links are folded into that line.
@7678837-glitch
7678837-glitch merged commit 81f351e into xjoker:dev Oct 19, 2026
4 checks passed
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.

1 participant