Skip to content

docs: rewrite onboarding prose for readers #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
legubiao merged 1 commit into from
Nov 13, 2026
Merged

docs: rewrite onboarding prose for readers #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .cursor/skills/docs-writing/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Do **not** document a hand-written `~/.bashrc` `source /opt/ros/...` chain as th

## Private repos

For `fa-deploy-ws`, remaining private FiveAges remotes (`fa-w2r-description`, `fa-s2r-description`, `fa-wce3-description`, `fiveages-gen3-robot-usds`), DexCap private workspace, `ocs2_wbc_controller`, and other 404-without-access remotes:
For `fa-deploy-ws`, remaining private FiveAges remotes (`fa-w2r-description`, `fa-s2r-description`), the DexCap private workspace, and other 404-without-access remotes:

- Tell readers to follow **that repository’s README after access**
- You may name the same **script name** as the public counterpart (`./init_repo.sh`) when that is the verified pattern
Expand All @@ -69,7 +69,8 @@ Keep **reader-facing product facts**:
- There is **no** `hardware:=mock`. Keys are `mock_components` / `gz` / `isaac` / `real`.
- `/fsm_command` is `std_msgs/Int32`, not strings such as `stand` / `walk`.
- Acone / AC One is **dual-arm** (双臂); Lift 2S is the **full-body** mobile manipulator. Do not call Acone arm-only / single-arm / 仅机械臂.
- Brand labels follow [robot_usds README_zh-CN.md §3.1](https://github.com/fiveages-sim/robot_usds/blob/main/README_zh-CN.md#31-中文简称与英文标识对照) (方舟无限 = ARX, never bare “Ark”; 高擎 = HighTorque / Panthera). On reader pages, use names naturally (quiet first-mention pairs such as **ARX** (方舟无限) are fine). Do not lecture “方舟无限 = ARX, not bare Ark” on every page.
- Brand labels follow [robot_usds README_zh-CN.md §3.1](https://github.com/fiveages-sim/robot_usds/blob/main/README_zh-CN.md#31-中文简称与英文标识对照) (方舟无限 = ARX, never bare “Ark”; 高擎 = HighTorque / Panthera). Reader Chinese for the FiveAges brand is **第五纪**. Do not rewrite repo URLs, `humanoid/FiveAges/`, or prim names such as `FiveAges_W2`. On reader pages, use names naturally (quiet first-mention pairs such as **ARX** (方舟无限) are fine). Do not lecture “方舟无限 = ARX, not bare Ark” on every page.
- `ocs2_wbc_controller`, `ocs2_humanoid`, and `lina_planning` ship in the GitHub Release package `ros-jazzy-arms-ros2-control`. Install with `./init_repo.sh` (arms = `d`) or `./scripts/install_core_debs.sh --only arms`. That script does not install `ros-jazzy-arms-ros2-control-full`, and the package is not on apt. Cloning the private repos is for reading or editing source. Do not claim other private descriptions or hardware repos are in this deb.

Feishu 运控 glossary: Chinese **驱动层** is the ros2_control **hardware interface** layer. English reader titles, sidebar labels, and cross-link text use **Hardware Interface(s)** — not **Driver layer** as the primary EN name. zh `.po` msgstr for those titles stays **驱动层**. Do not treat 硬件接口 and 驱动层 as two product layers. Glossary: `source/3-concepts/8-terminology.md`. Keep `hardware:=`, `<hardware>`, plugin class names, and `ros2 control list_hardware_interfaces` as code.

Expand Down
32 changes: 16 additions & 16 deletions locale/zh_CN/LC_MESSAGES/0-overview/1-architecture.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ msgstr "公开"
msgid "`fa-deploy-ws`"
msgstr "`fa-deploy-ws`"

#: ../../source/0-overview/1-architecture.md:7 a0ad6b97a1d24abdbcf791093528b5c1
#: ../../source/0-overview/1-architecture.md:7 72a092f922544977bb9ad258627fdf1b
msgid "Internal workspace for FA robots"
msgstr "面向 FA 机器人的内部工作空间"
msgstr "面向第五纪机器人的内部工作空间"

#: ../../source/0-overview/1-architecture.md:7 3826d0d76b594228ac3daf7fe3ddf7a0
#: a01f842c8fa840028c24c96021f9ce53
Expand Down Expand Up @@ -129,20 +129,6 @@ msgid ""
"launch utilities"
msgstr "**robot-descriptions-common** — 共用夹爪、灵巧手、传感器与 launch 工具"

#: ../../source/0-overview/1-architecture.md:88
#: 17032d5169504923a91d1cfc593c49c5
msgid ""
"**humanoid/FiveAges** — Gitlink packages under that umbrella (not a "
"separate `robot-descriptions-fiveages` repo). **Public:** W1, W2, S2, "
"`fa-w2-components`. **Still private:** **W2R**, **S2R** (not open yet), "
"Gen3. Paths: [FiveAges robot "
"descriptions](../4-reference/descriptions/4-fiveages_umbrella.md)"
msgstr ""
"**humanoid/FiveAges** — 该伞形仓下的 gitlink 包（不是独立的 `robot-descriptions-fiveages`"
"仓库）。**公开：** W1、W2、S2、`fa-w2-components`。**仍为私有：**"
"**W2R**、**S2R**（尚未开放）、Gen3。路径：[FiveAges"
"机器人描述](../4-reference/descriptions/4-fiveages_umbrella.md)"

#: ../../source/0-overview/1-architecture.md:89
#: b78f5550154c41fa8a36c90643c97d00
msgid "**Brand packages** — Per-vendor descriptions (dobot, arx, galbot, etc.)"
Expand Down Expand Up @@ -374,3 +360,17 @@ msgstr "Test in mock → simulation → real hardware"
#~ msgid "L2: Driver layer"
#~ msgstr "L2：驱动层"

#: ../../source/0-overview/1-architecture.md:88
#: dc5874027d74457f9479a6ffde8b1bfc
msgid ""
"**humanoid/FiveAges** — Gitlink packages under that umbrella. There is no"
" separate `robot-descriptions-fiveages` repo. **Public:** W1, W2, S2, "
"`fa-w2-components`. **Still private:** **W2R** and **S2R**. Paths: "
"[FiveAges robot "
"descriptions](../4-reference/descriptions/4-fiveages_umbrella.md)"
msgstr ""
"**humanoid/FiveAges** 是这个伞形仓里的 gitlink，没有单独的 `robot-descriptions-"
"fiveages` 仓库。**公开：** W1、W2、S2、`fa-w2-components`。**仍私有：** **W2R** 和 "
"**S2R**。路径见 "
"[第五纪机器人描述](../4-reference/descriptions/4-fiveages_umbrella.md)。"

Loading
Loading