Skip to content

chore: redesign GitHub org profile README#52

Merged
yuanyuanxin merged 8 commits intomainfrom
chore/redesign-org-profile
Mar 13, 2026
Merged

chore: redesign GitHub org profile README#52
yuanyuanxin merged 8 commits intomainfrom
chore/redesign-org-profile

Conversation

@yuanyuanxin
Copy link
Contributor

@yuanyuanxin yuanyuanxin commented Mar 12, 2026

Summary

  • Replace Unitree-style HTML table + shields badge layout with brand-narrative driven design
  • Add YouTube video thumbnails with play button overlay for Wuji Hand and Wuji Glove
  • Update product descriptions based on actual codebase capabilities (read from firmware and SDK source code)
  • Simplify layout: remove repo list, streamline product cards into 2×2 grid
  • Split intro text into two lines for better readability

Test Plan

🤖 Generated with Claude Code

Summary by CodeRabbit

  • 文档
    • 重构项目档案页布局:头部为居中大徽标并更新徽标替代文本,介绍段改为居中产品聚焦说明(手、数据手套、软件栈)。
    • 用网站/文档/X/YouTube/Bilibili 徽章替换单行联系方式。
    • 新增产品生态区,卡片式两栏展示(Wuji Hand/Glove/Studio/SDK)并附文档链接。
    • 将开源项目目录合并为按类别的仓库汇总并以表格化方式呈现。
    • 新增“参与我们”版块,涵盖技术支持、合作与招聘联系方式。

- Replace shields.io badge wall with flat brand-colored badges
- Add YouTube video thumbnails with play button overlay for Hand and Glove
- Update product descriptions based on actual codebase capabilities
- Simplify layout: remove repo list, streamline product cards
- Split intro text into two lines for better readability

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

重构 profile/README.md:将头部与徽章居中、改为产品生态展示(四款产品卡片)、将多表格的开源项目合并为按类别的 Repositories 列表,并新增参与/联系节,调整章节顺序。(≤50字)

Changes

Cohort / File(s) Summary
README 重构
profile/README.md
全面重写主页文档:替换头部 logo 与简介为居中大版块;将联系人信息改为网站/Docs/X/YouTube/Bilibili 徽章行;新增“产品生态”两列卡片(Wuji Hand、Wuji Glove、Wuji Studio、Wuji SDK)并附 Docs 链接;将原多表格开源项目合并为按类别的 Repositories(SDK、Tools、Simulation、Teleoperation、Hardware、Education);新增 “Get Involved/参与方式” 节,包含技术支持、销售/合作与招聘联系方式;调整章节顺序与内容组织。

Sequence Diagram(s)

(本次更改为文档重构,未引入跨组件控制流,故无序列图)

预计代码审查工作量

🎯 3 (Moderate) | ⏱️ ~20 minutes

可能相关的 PR

建议审查者

  • chenjunnn
  • christopheralex-cc

🐰 新页展翼迎风飞,
徽章排队亮晶晶,
四款生态并列美,
仓库归档路更齐,
欢迎来访共筑坞 🥕


✅ Pre-merge checks override applied

The pre-merge checks have been overridden successfully. You can now proceed with the merge.

Overridden by @yuanyuanxin via checkbox on 2026-03-12T03:49:03.360Z.

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Changelog ❌ Error [IGNORED] PR引入了用户面向变更(profile/README.md重新设计),但CHANGELOG.md中的[Unreleased]部分未记录这些变更,仅记录了脚本和workflow相关的更改。 在CHANGELOG.md的[Unreleased]部分添加profile README重新设计的变更记录,并确保public/CHANGELOG.md文件存在且包含相应内容。
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 标题遵循 Conventional Commits 格式,明确指出变更类型(chore)和具体范围(redesign GitHub org profile README),清晰描述了主要改动。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Pr Description ✅ Passed PR描述明确包含了测试计划,列出了三个具体的测试项目。由于PR源分支为 chore/redesign-org-profile,以 chore/ 开头,工作项引用要求已被豁免。
Branch Name ✅ Passed 源分支名称 chore/redesign-org-profile 完全符合规定的分支命名规范,使用了正确的 "chore/" 前缀和清晰的描述性名称。
Design Docs ✅ Passed 跳过条件已满足——docs/internal/design/ 和 docs/internal/architecture/ 目录在仓库中均不存在,PR 仅涉及 profile/README.md 文档更新,不涉及代码逻辑改动。
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/redesign-org-profile
📝 Coding Plan
  • Generate coding plan for human review comments

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@profile/README.md`:
- Around line 20-53: Remove the fixed two-column <table> layout (the <table> and
the <td align="center" width="50%"> cells) and replace it with a responsive
stackable layout so narrow screens render a single column; specifically, stop
using width="50%" on the <td> elements and convert the cards (Wuji Hand, Wuji
Glove, Wuji Studio, Wuji SDK) into vertically stacked blocks (e.g., simple <div>
card elements or a flex/grid container with CSS that switches from two-columns
to one-column via a media query or responsive utility classes) so mobile devices
automatically display a single column without horizontal scrolling.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3bb3d5fd-6387-44f2-bf94-7a8d9f79fe5b

📥 Commits

Reviewing files that changed from the base of the PR and between fcca135 and 10d30fd.

⛔ Files ignored due to path filters (2)
  • images/wuji-glove-video.jpg is excluded by !**/*.jpg
  • images/wuji-hand-video.jpg is excluded by !**/*.jpg
📒 Files selected for processing (1)
  • profile/README.md

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 12, 2026
Shadow2223
Shadow2223 previously approved these changes Mar 12, 2026
Add categorized repo listing (SDK, Tools, Simulation, Teleoperation,
Hardware, Education) below Product Ecosystem cards. Each repo shows
an inline release version badge linked to its latest release page.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
profile/README.md (1)

42-42: 固定高度可能影响内容灵活性。

第二行的单元格使用了 height="120" 固定高度。如果未来产品描述内容增加或需要支持其他语言(内容长度可能不同),固定高度可能导致内容溢出或布局不协调。建议移除固定高度属性,让内容自适应。

♻️ 建议的改进
-    <td align="center" width="50%" height="120">
+    <td align="center" width="50%">
      <h3>Wuji Studio</h3>
      Desktop app for device management, data visualization, and firmware upgrade<br><br>
      <a href="https://docs.wuji.tech/docs/en/wuji-studio/latest">Docs →</a>
    </td>
-    <td align="center" width="50%" height="120">
+    <td align="center" width="50%">
      <h3>Wuji SDK</h3>
      Python SDK for sensor streaming, hand pose computation, and recording<br><br>
      <a href="https://docs.wuji.tech/docs/en/wuji-sdk/latest">Docs →</a>

Also applies to: 47-47

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@profile/README.md` at line 42, The README's table cell uses a fixed height
attribute (the td element with align="center" width="50%" height="120"), which
can cause overflow or layout issues when content length varies; remove the
height="120" attribute from that td (and the similar td instance) and instead
allow the cell to size naturally or apply a responsive CSS class/min-height
(e.g., use a className like .profile-cell with min-height or flexible layout
rules) so content can grow and support multi-language text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@profile/README.md`:
- Line 42: The README's table cell uses a fixed height attribute (the td element
with align="center" width="50%" height="120"), which can cause overflow or
layout issues when content length varies; remove the height="120" attribute from
that td (and the similar td instance) and instead allow the cell to size
naturally or apply a responsive CSS class/min-height (e.g., use a className like
.profile-cell with min-height or flexible layout rules) so content can grow and
support multi-language text.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7415cd91-3332-4b43-9143-78078d1ddbd0

📥 Commits

Reviewing files that changed from the base of the PR and between 10d30fd and a0dce3f.

📒 Files selected for processing (1)
  • profile/README.md

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 12, 2026
Replace separate repo link + version badge with single combined badge
(repo name + version in one shield). Add tooltip on hover. Keep inline
description text after badge separated by hyphen.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
profile/README.md (1)

42-51: 固定高度可能导致内容溢出。

Lines 42 和 47 的 height="120" 固定高度在产品描述文本较长或窄屏环境下可能导致内容被裁剪。建议移除 height 属性,让单元格高度自适应内容。

♻️ 建议移除固定高度
-    <td align="center" width="50%" height="120">
+    <td align="center" width="50%">
       <h3>Wuji Studio</h3>
       Desktop app for device management, data visualization, and firmware upgrade<br><br>
       <a href="https://docs.wuji.tech/docs/en/wuji-studio/latest">Docs →</a>
     </td>
-    <td align="center" width="50%" height="120">
+    <td align="center" width="50%">
       <h3>Wuji SDK</h3>
       Python SDK for sensor streaming, hand pose computation, and recording<br><br>
       <a href="https://docs.wuji.tech/docs/en/wuji-sdk/latest">Docs →</a>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@profile/README.md` around lines 42 - 51, The two table cells with fixed
height attributes (the <td> containing "Wuji Studio" and the <td> containing
"Wuji SDK") use height="120", which can cause content clipping on narrow
screens; remove the height="120" attributes from those <td> elements so the cell
height becomes content-driven (auto) and the descriptions can wrap without being
cut off.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@profile/README.md`:
- Around line 42-51: The two table cells with fixed height attributes (the <td>
containing "Wuji Studio" and the <td> containing "Wuji SDK") use height="120",
which can cause content clipping on narrow screens; remove the height="120"
attributes from those <td> elements so the cell height becomes content-driven
(auto) and the descriptions can wrap without being cut off.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b6c3b3f3-acdc-42e2-9f13-ed826593c8fc

📥 Commits

Reviewing files that changed from the base of the PR and between a0dce3f and 319e957.

📒 Files selected for processing (1)
  • profile/README.md

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 12, 2026
Separate badge and description into individual columns with rowspan
for category grouping, improving readability.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
GitHub strips CSS classes and <style> tags. Use align/valign attributes
directly on <td> elements for category and badge column centering.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
profile/README.md (1)

42-47: 建议移除固定高度属性以避免潜在的文本溢出。

Line 42 和 Line 47 的 height="120" 固定了单元格高度。如果未来产品描述变长、添加多语言内容或在某些浏览器中渲染,可能导致文本溢出或被截断。建议移除 height 属性,让单元格高度自适应内容。

♻️ 建议的调整
-    <td align="center" width="50%" height="120">
+    <td align="center" width="50%">
      <h3>Wuji Studio</h3>
      Desktop app for device management, data visualization, and firmware upgrade<br><br>
      <a href="https://docs.wuji.tech/docs/en/wuji-studio/latest">Docs →</a>
    </td>
-    <td align="center" width="50%" height="120">
+    <td align="center" width="50%">
      <h3>Wuji SDK</h3>
      Python SDK for sensor streaming, hand pose computation, and recording<br><br>
      <a href="https://docs.wuji.tech/docs/en/wuji-sdk/latest">Docs →</a>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@profile/README.md` around lines 42 - 47, 在 profile/README.md 中将含有
height="120" 的 <td> 单元格移除固定高度属性(即删除 height="120" 出现在 <td align="center"
width="50%" height="120">
的两个单元格),让表格单元格高度随内容自适应;保留其他属性(align、width)不变,以避免文本在多语言或长描述时溢出或被截断。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@profile/README.md`:
- Around line 42-47: 在 profile/README.md 中将含有 height="120" 的 <td>
单元格移除固定高度属性(即删除 height="120" 出现在 <td align="center" width="50%" height="120">
的两个单元格),让表格单元格高度随内容自适应;保留其他属性(align、width)不变,以避免文本在多语言或长描述时溢出或被截断。

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 90474c6b-e60a-42be-a9ce-27fde27a4393

📥 Commits

Reviewing files that changed from the base of the PR and between 319e957 and 4563fb1.

📒 Files selected for processing (1)
  • profile/README.md

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
profile/README.md (2)

59-59: 统一分类列的宽度属性。

第 59 行的分类单元格包含 width="120" 属性,但第 72 行和第 85 行缺少此属性。为保持布局一致性,建议为所有分类单元格添加相同的宽度设置。

♻️ 建议的统一修改
-    <td rowspan="3" align="center" valign="middle"><b>Tools</b></td>
+    <td rowspan="3" width="120" align="center" valign="middle"><b>Tools</b></td>
-    <td rowspan="3" align="center" valign="middle"><b>Simulation</b></td>
+    <td rowspan="3" width="120" align="center" valign="middle"><b>Simulation</b></td>

Also applies to: 72-72, 85-85

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@profile/README.md` at line 59, The table's category cells are inconsistent:
the <td> with <b>SDK</b> has width="120" but the other category <td> elements
(the ones containing the other <b>...</b> category labels) are missing this
attribute; update those <td> tags so each category cell uses the same
width="120" attribute (i.e., add width="120" to the other category <td> elements
to match the <td rowspan="3" width="120" align="center"
valign="middle"><b>SDK</b></td> pattern).

23-25: 改进视频链接的无障碍性。

建议为视频链接添加更明确的说明,让用户知道点击后会跳转到 YouTube。可以在图片的 alt 属性中添加更详细的描述。

♻️ 建议的改进
      <a href="https://www.youtube.com/watch?v=LXVV-oErD8s">
-        <img src="../images/wuji-hand-video.jpg" width="100%" alt="Wuji Hand">
+        <img src="../images/wuji-hand-video.jpg" width="100%" alt="Wuji Hand demonstration video (YouTube)">
      </a>
      <a href="https://www.youtube.com/watch?v=NE5FytzRz_E">
-        <img src="../images/wuji-glove-video.jpg" width="100%" alt="Wuji Glove">
+        <img src="../images/wuji-glove-video.jpg" width="100%" alt="Wuji Glove demonstration video (YouTube)">
      </a>

Also applies to: 32-34

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@profile/README.md` around lines 23 - 25, 为提高无障碍性和可见性,更新视频链接的锚点和图片描述:在 <a
href="https://www.youtube.com/watch?v=LXVV-oErD8s"> 元素上添加一个描述性 title 或
aria-label(例如“在 YouTube 打开视频:Wuji Hand(将在新标签页打开)”),并把 <img ... alt="Wuji Hand">
的 alt 改为更具体的描述(例如“Wuji Hand 视频缩略图 — 点击将在 YouTube 新标签页打开”),可选地为锚点添加
target="_blank" 和 rel="noopener noreferrer" 以安全在新标签打开。确保对文件中相同模式的其它实例(行
32-34)做相同修改。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@profile/README.md`:
- Around line 42-47: The table cells use a fixed height attribute (height="120")
on the <td> elements which can cause content clipping on different screen sizes;
remove the height="120" attribute from the affected <td> elements (the two <td
align="center" width="50%" ...> entries) so the cells can auto-size based on
their content, or replace it with responsive CSS if a minimum height is
required.

---

Nitpick comments:
In `@profile/README.md`:
- Line 59: The table's category cells are inconsistent: the <td> with <b>SDK</b>
has width="120" but the other category <td> elements (the ones containing the
other <b>...</b> category labels) are missing this attribute; update those <td>
tags so each category cell uses the same width="120" attribute (i.e., add
width="120" to the other category <td> elements to match the <td rowspan="3"
width="120" align="center" valign="middle"><b>SDK</b></td> pattern).
- Around line 23-25: 为提高无障碍性和可见性,更新视频链接的锚点和图片描述:在 <a
href="https://www.youtube.com/watch?v=LXVV-oErD8s"> 元素上添加一个描述性 title 或
aria-label(例如“在 YouTube 打开视频:Wuji Hand(将在新标签页打开)”),并把 <img ... alt="Wuji Hand">
的 alt 改为更具体的描述(例如“Wuji Hand 视频缩略图 — 点击将在 YouTube 新标签页打开”),可选地为锚点添加
target="_blank" 和 rel="noopener noreferrer" 以安全在新标签打开。确保对文件中相同模式的其它实例(行
32-34)做相同修改。

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b8d981b5-7c82-447e-8475-b9e6ffee726f

📥 Commits

Reviewing files that changed from the base of the PR and between 4563fb1 and dd9889e.

📒 Files selected for processing (1)
  • profile/README.md

yuanyuanxin and others added 3 commits March 12, 2026 17:31
Use <picture> element with prefers-color-scheme to show
dark logo on light backgrounds and light logo on dark backgrounds.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…repo

- Clean SVG metadata: remove Chinese layer IDs, XML declaration, and
  CSS class references; use inline fill attributes instead
- Add spacing between logo and tagline per brand clear space spec
- Add wuji-hand-teleop to Teleoperation category in Repositories table

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@yuanyuanxin
Copy link
Contributor Author

@CodeRabbit approve

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 13, 2026

✅ Actions performed

Comments resolved and changes approved.

@yuanyuanxin yuanyuanxin merged commit ecf2a27 into main Mar 13, 2026
1 check passed
@yuanyuanxin yuanyuanxin deleted the chore/redesign-org-profile branch March 13, 2026 03:28
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.

3 participants