Skip to content

Update Japanese README - #2

Merged
s2015-turtle merged 1 commit into
mainfrom
docs/update-japanese-readme
Jul 21, 2026
Merged

Update Japanese README#2
s2015-turtle merged 1 commit into
mainfrom
docs/update-japanese-readme

Conversation

@s2015-turtle

Copy link
Copy Markdown
Owner

Summary

  • align the Japanese README with the current English README and implementation
  • document the private-protocol and 1 Mbit/s SocketCAN prerequisites
  • clarify gear_ratio, startup attempts, watchdog defaults, and shutdown behavior
  • remove internal Type-number, DDS worker, and queue implementation details

Why

The Japanese README predated the latest user-facing documentation cleanup. Some wording could be misread, particularly the transmission ratio and retry semantics, while important setup requirements were missing.

User impact

Japanese-speaking users now receive the same setup, safety, supported-model, and command-mode guidance as readers of the English README.

Validation

  • compared parameter names and defaults with driver_config.cpp
  • compared lifecycle, recovery, and shutdown behavior with driver.cpp
  • checked model-profile values against robstride_motor_profiles.xacro
  • ran git diff --check

Documentation-only change; no local build was run.

@s2015-turtle s2015-turtle added documentation Improvements or additions to documentation maintenance Refactoring, cleanup, and repository maintenance labels Jul 21, 2026
@s2015-turtle
s2015-turtle merged commit 52ab0d0 into main Jul 21, 2026
5 checks passed
@s2015-turtle
s2015-turtle deleted the docs/update-japanese-readme branch July 21, 2026 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance Refactoring, cleanup, and repository maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant