Skip to content

docs(README.zh-CN): sync Product Hunt badge + install URL with English#2033

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
YOMXXX:docs/sync-zh-cn-readme-drift
May 18, 2026
Merged

docs(README.zh-CN): sync Product Hunt badge + install URL with English#2033
senamakel merged 1 commit into
tinyhumansai:mainfrom
YOMXXX:docs/sync-zh-cn-readme-drift

Conversation

@YOMXXX
Copy link
Copy Markdown
Contributor

@YOMXXX YOMXXX commented May 18, 2026

Summary

Problem

README.zh-CN.md is the user-facing landing page for Chinese-speaking visitors arriving via the language badge / Trendshift / Product Hunt referrals. Two upstream changes drifted away from it:

  1. Product Hunt badge (Update README.md #1895, commit bd5c2ed3): the English README migrated the embed from badge-featured / featured.svg to badge-top-post-badge / top-post-badge.svg, and merged the two separate <p> blocks (one for Trendshift, one for Product Hunt) into a single centred row with &nbsp; spacing. The Chinese README still shows the older featured badge in its own block, so visitors see a stale "OpenHuman is Featured" widget instead of the current "Top Post" widget — and the layout differs between editions.

  2. Install URL (Update README.md #1903, commit df542e72): the English README dropped ?utm_source=github&utm_medium=readme from the URL inside the install code block's comment, so the URL shown to users matches what they would actually type. The Chinese README still carries the tracking parameters in the comment, which is both inconsistent and slightly confusing (the prose link above it kept the params; only the in-code comment was simplified).

README.ja-JP.md was added later (#2005) and already includes both fixes, so it does not need touching in this PR.

Solution

Apply the two upstream diffs to README.zh-CN.md:

  • Replace the featured Product Hunt block with the top-post-badge markup and collapse the two <p> blocks into one, matching README.md line 7-16 byte-for-byte (apart from the surrounding Chinese prose).
  • Drop ?utm_source=github&utm_medium=readme from the comment line inside the install code block (line 48), matching README.md line 49.

No other content is touched. This is the minimal diff that re-aligns the Chinese edition to the English source as of main.

Submission Checklist

Impact

  • Runtime / platform: none.
  • Performance / security / migration / compatibility: none.
  • User-visible: Chinese-speaking visitors now see the current "Top Post" Product Hunt badge in the same layout as the English README, and the in-code install comment shows a clean URL.

Related


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

Human-authored PR — fields marked N/A.

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: docs/sync-zh-cn-readme-drift
  • Commit SHA: d535fe13

Validation Run

  • pnpm --filter openhuman-app format:checkN/A: no app/* files changed.
  • pnpm typecheckN/A: no TypeScript changed.
  • Focused tests: N/A: docs-only change.
  • Rust fmt/check (if changed): N/A: no .rs changed.
  • Tauri fmt/check (if changed): N/A: no Tauri code changed.

Validation Blocked

  • command: N/A
  • error: N/A
  • impact: N/A

Behavior Changes

  • Intended behavior change: None (documentation only).
  • User-visible effect: Chinese-speaking visitors see the current Product Hunt badge and a clean install URL, matching the English README.

Parity Contract

  • Legacy behavior preserved: Yes — no code paths touched. Chinese copy preserves all prose; only the two drifted blocks are realigned.
  • Guard/fallback/dispatch parity checks: N/A.

Duplicate / Superseded PR Handling

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

Summary by CodeRabbit

  • Documentation
    • Updated Product Hunt badge presentation in Chinese README
    • Simplified installation link with cleaner URL format

Review Change Stack

Two upstream README.md commits landed after the Simplified Chinese
README was created (tinyhumansai#1890) and were not mirrored into README.zh-CN.md:

- tinyhumansai#1895 (bd5c2ed): Product Hunt badge migrated from
  `badge-featured` / `featured.svg` to `badge-top-post-badge` /
  `top-post-badge.svg`, and the two `<p>` blocks holding the Trendshift
  and Product Hunt badges were merged into a single centred block with
  `&nbsp;` spacing.
- tinyhumansai#1903 (df542e7): the download-instructions code block dropped the
  `?utm_source=github&utm_medium=readme` query parameters from the
  comment so the visible URL matches what users would type.

This PR applies both diffs verbatim to README.zh-CN.md so the Chinese
edition matches the English source. README.ja-JP.md is already in sync
with both changes — no edit needed there.
@YOMXXX YOMXXX requested a review from a team May 18, 2026 02:34
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: eed5e5ed-3422-4080-be4a-aa6dcd4061a2

📥 Commits

Reviewing files that changed from the base of the PR and between c99d1eb and d535fe1.

📒 Files selected for processing (1)
  • README.zh-CN.md

📝 Walkthrough

Walkthrough

Updated the Chinese README header by replacing the Product Hunt featured widget with a top-post widget and simplified the installation instruction comment to use a direct link without tracking parameters.

Changes

Documentation Updates

Layer / File(s) Summary
Product Hunt badge widget update
README.zh-CN.md
Product Hunt badge embed block switched from featured widget to top-post-badge widget with adjusted anchor/img markup.
Installation link simplification
README.zh-CN.md
Installation instruction comment updated to reference https://tinyhumans.ai/openhuman without prior GitHub utm_source parameter.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 A badge doth shine more brightly now,
From featured to top-post we bow,
And links made clean without the noise,
Just simple paths that bring us joys!
Chinese docs dressed up fresh and neat,
A tiny change, a fresh repeat! ✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@senamakel senamakel merged commit 63ea7f6 into tinyhumansai:main May 18, 2026
19 of 20 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 21, 2026
12 tasks
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
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.

Suggestion: Add a Chinese version of README (README.zh-CN.md)

2 participants