(ja_version) sync user_guide with main (full translation update + structure and warning fixes)#101
(ja_version) sync user_guide with main (full translation update + structure and warning fixes)#101hamataku wants to merge 98 commits intoGenesis-Embodied-AI:ja_versionfrom
Conversation
- Replaced "creaing" with "creating" - Replaced "accidently" with "accidentally"
docs: fix minor spelling errors in diff-sim doc.
This commit includes Training Drone Hovering Policies with RL, without demo videos.
add demo video to html
Update Drone Hovering Tutorial
Fix typo in collision_representation.md
change hyper params update curve, eval_video and add training.gif
update hover_env.md with images and videos
Added a complete name and link to the shorthand reference to a PD controller. Probably people coming from the more software side of things would not understand what PD stands for.
Update control_your_robot.md
Update hover_env.md
…x_missing_misc Fix missing file.
duburcqa
left a comment
There was a problem hiding this comment.
Note: This is a curated AI-generated review, verified and refined by a project maintainer.
Review: sync user_guide with main (full translation update + structure and warning fixes)
What's good
- Placeholder pages replaced with real content —
concepts.md,collision_representation.md,sparse_computation.mdwere all "Coming soon..." stubs and are now either fleshed out or properly removed. taichi→quadrantsmigration inrequirements.txt— correctly reflects the engine rename..DS_Storecleanup — macOS metadata files properly removed.- Heading levels fixed in
hello_genesis.md—####promoted to##, correct for Sphinx rendering. - Directory rename
rigidentity/→rigid_entity/— better naming consistency. - Many new translated user guide pages — sensors, SAP coupler, hybrid entities, manipulation, constraints, terrain, domain randomization, viewer plugins, recorders, etc.
- API reference restructured with proper hierarchy (engine, solvers, couplers, states, sensors, recording, visualization, differentiation, utilities, materials).
Issues
1. Delete deprecated IPC coupler doc rather than translating it.
source/user_guide/advanced_topics/ipc_coupler.md translates content that is already deprecated in the English main branch. This page should be removed entirely rather than shipped as new Japanese content. The same logic applies to any other pages that document APIs already deprecated in main — translating dead content creates maintenance burden and misleads users.
2. English API reference pages on a Japanese branch.
The ~60 new files under source/api_reference/ (differentiation, engine, couplers, sensors, recording, utilities, visualization) are entirely in English. If the ja_version branch is meant to be a Japanese documentation site, these should either be translated or explicitly marked as English-only. The inconsistency will be jarring for Japanese readers.
3. Commented-out HTML block in concepts.md.
There's a <!-- ... --> comment block that contains a near-duplicate of the paragraph immediately below it. This dead content should be removed.
4. differentiable_simulation.md content lost for Japanese readers.
The deleted page had substantive content about genesis.Tensor (creation patterns, scene attribute, zero_grad(), interaction with PyTorch). It was removed from the advanced topics toctree with no Japanese replacement — the new differentiable simulation content only exists in the English API reference. Japanese users lose this explanation.
duburcqa
left a comment
There was a problem hiding this comment.
Note: This is a curated AI-generated review, verified and refined by a project maintainer.
Review: sync user_guide with main (full translation update + structure and warning fixes)
What's good
- Placeholder pages replaced with real content —
concepts.md,collision_representation.md,sparse_computation.mdwere all "Coming soon..." stubs and are now either fleshed out or properly removed. taichi→quadrantsmigration inrequirements.txt— correctly reflects the engine rename..DS_Storecleanup — macOS metadata files properly removed.- Heading levels fixed in
hello_genesis.md—####promoted to##, correct for Sphinx rendering. - Directory rename
rigidentity/→rigid_entity/— better naming consistency. - Many new translated user guide pages — sensors, SAP coupler, hybrid entities, manipulation, constraints, terrain, domain randomization, viewer plugins, recorders, etc.
- API reference restructured with proper hierarchy (engine, solvers, couplers, states, sensors, recording, visualization, differentiation, utilities, materials).
Issues
1. Delete deprecated IPC coupler doc rather than translating it.
source/user_guide/advanced_topics/ipc_coupler.md translates content that is already deprecated in the English main branch. This page should be removed entirely rather than shipped as new Japanese content. The same logic applies to any other pages that document APIs already deprecated in main — translating dead content creates maintenance burden and misleads users.
2. English API reference pages on a Japanese branch.
The ~60 new files under source/api_reference/ (differentiation, engine, couplers, sensors, recording, utilities, visualization) are entirely in English. If the ja_version branch is meant to be a Japanese documentation site, these should either be translated or explicitly marked as English-only. The inconsistency will be jarring for Japanese readers.
3. Commented-out HTML block in concepts.md.
There's a <!-- ... --> comment block that contains a near-duplicate of the paragraph immediately below it. This dead content should be removed.
4. differentiable_simulation.md content lost for Japanese readers.
The deleted page had substantive content about genesis.Tensor (creation patterns, scene attribute, zero_grad(), interaction with PyTorch). It was removed from the advanced topics toctree with no Japanese replacement — the new differentiable simulation content only exists in the English API reference. Japanese users lose this explanation.
|
Thank you for your review. Issue 1 Issue 2 Issue 3 Issue 4 |
Hello,
This PR updates the Japanese documentation under
user_guideto align with the current main branch.Changes include:
The translation/maintenance workflow was done with an AI agent, and I manually reviewed the results.
Thanks.