Skip to content

fix(docs): update README - #5784

Open
Dazzanova wants to merge 1 commit into
tinyhumansai:mainfrom
Dazzanova:fix-readme
Open

fix(docs): update README#5784
Dazzanova wants to merge 1 commit into
tinyhumansai:mainfrom
Dazzanova:fix-readme

Conversation

@Dazzanova

@Dazzanova Dazzanova commented Aug 26, 2026

Copy link
Copy Markdown

Summary

  • Update all 6 README files to say Rust 1.96.1 instead of Rust 1.93.0.
  • Keep the documented Rust version consistent with rust-toolchain.toml and CONTRIBUTING.md.

Problem

  • The README and all translated README versions currently instruct contributors to install Rust 1.93.0.
  • The repository actually pins Rust 1.96.1 in rust-toolchain.toml, and CONTRIBUTING.md already documents 1.96.1.

Solution

  • Updated the Rust version from 1.93.0 to 1.96.1 in all six affected README files:
    • README.md
    • docs/README.zh-CN.md
    • docs/README.de.md
    • docs/README.ja-JP.md
    • docs/README.ko.md
    • docs/README.ur-pk.md
  • The documented version now matches the repository's rust-toolchain.toml and CONTRIBUTING.md.

Submission Checklist

If a section does not apply to this change, mark the item as N/A with a one-line reason. Do not delete items.

  • Tests added or updated (happy path + at least one failure / edge case) per Testing Strategy

    • N/A: Documentation-only version correction; no runtime behavior changed.
  • Diff coverage ≥ 80% — changed lines (Vitest + cargo-llvm-cov merged via diff-cover) meet the gate enforced by .github/workflows/ci-lite.yml. Run pnpm test:coverage and pnpm test:rust locally; PRs below 80% on changed lines will not merge.

    • N/A: Documentation-only change; no executable code was modified.
  • Coverage matrix updated — added/removed/renamed feature rows in docs/TEST-COVERAGE-MATRIX.md reflect this change (or N/A: behaviour-only change)

    • N/A: No features, behavior, or coverage requirements changed.
  • All affected feature IDs from the matrix are listed in the PR description under ## Related

    • N/A: No affected feature IDs.
  • No new external network dependencies introduced (mock backend used per Testing Strategy

    • N/A: No dependencies or network behavior changed.
  • Manual smoke checklist updated if this touches release-cut surfaces (docs/RELEASE-MANUAL-SMOKE.md

    • N/A: Documentation-only change; release-cut behavior is unaffected.
  • Linked issue closed via Closes #NNN in the ## Related section

    • Closes #ISSUE_NUMBER

Impact

  • Runtime/platform: None. This PR only updates contributor documentation.
  • Performance: None.
  • Security: None.
  • Migration: None.
  • Compatibility: No runtime compatibility changes. The documented Rust version is corrected to match the version already required by the repository.
  • Contributor experience: Contributors following the README will be directed to the Rust version required by the current dependency/toolchain configuration.

Related

Closes #5781

  • Follow-up PR(s)/TODOs: None

AI Authored PR Metadata (required for Codex/Linear PRs)

Keep this section for AI-authored PRs. For human-only PRs, mark each field N/A.

Linear Issue

  • Key: N/A: No Linear issue associated with this change.
  • URL: N/A

Commit & Branch

  • Branch: fix-readme
  • Commit SHA: <8157f414602effbc09532bd5f096d6ab7ab9a52e

Validation Run

  • pnpm --filter openhuman-app format:check

    • N/A: Documentation-only change; no application source formatting is affected.
  • pnpm typecheck

    • N/A: Documentation-only change; no TypeScript source changed.
  • Focused tests:

    • N/A: Documentation-only change; no runtime behavior changed.
  • Rust fmt/check (if changed):

    • N/A: No Rust source files changed.
  • Tauri fmt/check (if changed):

    • N/A: No Tauri source files changed.

Validation Blocked

  • command: N/A
  • error: N/A
  • impact: N/A: Validation was not blocked; the listed code-validation commands are not applicable to a documentation-only change.

Behavior Changes

  • Intended behavior change: None. This PR only corrects the documented Rust prerequisite.
  • User-visible effect: Contributors will see Rust 1.96.1 instead of 1.93.0 when following the "Contributing from source" instructions.

Parity Contract

  • Legacy behavior preserved: Yes. No runtime or application behavior is changed.
  • Guard/fallback/dispatch parity checks: N/A: No runtime guards, fallbacks, or dispatch logic changed.

Duplicate / Superseded PR Handling

  • Duplicate PR(s): None known.
  • Canonical PR: This PR.
  • Resolution (closed/superseded/updated): N/A

Summary by CodeRabbit

  • Documentation
    • Updated contribution and build instructions to require Rust 1.96.1 instead of Rust 1.93.0.
    • Applied the updated requirement across English, German, Japanese, Korean, Urdu, and Simplified Chinese documentation.

@Dazzanova
Dazzanova requested a review from a team August 26, 2026 13:24

@tinysweeper tinysweeper 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.

tinysweeper found nothing blocking. Approving.

$0.0000 · 0 in / 0 out

@tinysweeper tinysweeper Bot added the priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect. label Aug 26, 2026
@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b39584b7-512d-4489-a0ea-4226d2ef43f9

📥 Commits

Reviewing files that changed from the base of the PR and between 77fddf5 and 8157f41.

📒 Files selected for processing (6)
  • README.md
  • docs/README.de.md
  • docs/README.ja-JP.md
  • docs/README.ko.md
  • docs/README.ur-pk.md
  • docs/README.zh-CN.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The contributor instructions in the English, German, Japanese, Korean, Urdu, and Chinese README files now require Rust 1.96.1 instead of Rust 1.93.0.

Changes

Rust prerequisite documentation

Layer / File(s) Summary
Update README prerequisites
README.md, docs/README.de.md, docs/README.ja-JP.md, docs/README.ko.md, docs/README.ur-pk.md, docs/README.zh-CN.md
All six README files now specify Rust 1.96.1. The rustfmt and clippy requirements remain unchanged.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 8157f

This documentation-only change corrects the Rust version shown to contributors without changing runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: senamakel

Poem

A rabbit checks the version line,

“One point nine six!” the tools align.
Rustfmt hops, Clippy gleams,
Six README paths now match their schemes.
The build guide springs fresh and bright.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The pull request updates all six README files from Rust 1.93.0 to 1.96.1, matching the linked issue requirements and the repository toolchain and contribution prerequisites.
Out of Scope Changes check ✅ Passed All changes are limited to the requested documentation updates. No unrelated code or runtime changes are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately identifies a documentation update to the README files. It does not specify the Rust version change, but it remains concise and related to the main change.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (6 skipped: 6 unsupported.)

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands.

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

Labels

priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README says Rust 1.93.0 but rust-toolchain.toml requires 1.96.1

1 participant