Skip to content

Conversation

@GyuH13
Copy link
Member

@GyuH13 GyuH13 commented Nov 24, 2025

Dynamixel Easy SDK python manual is added.
For check manual example, use jekyll.

ROBOTIS-GIT/DynamixelSDK#669

You can see an example of manual through below process.

Install Jekyll

$ sudo apt install ruby-full build-essential zlib1g-dev
$ echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
$ echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
$ source ~/.bashrc
$ gem install jekyll bundler

$ git clone -b feature-easy-sdk-python https://github.com/ROBOTIS-GIT/emanual.git
$ cd ~/emanual
$ bundle install
$ bundle update
$ bundle exec jekyll serve --incremental

It may take a few minutes the first time.
Open the URL that appeared in the terminal.

Signed-off-by: Hyungyu Kim <[email protected]>
@GyuH13 GyuH13 self-assigned this Nov 24, 2025
@GyuH13 GyuH13 added the documentation Improvements or additions to documentation label Nov 24, 2025
@GyuH13 GyuH13 added this to Platform Nov 24, 2025
@github-project-automation github-project-automation bot moved this to 🌱 Todo in Platform Nov 24, 2025
@GyuH13 GyuH13 moved this from 🌱 Todo to 📝 Pull Request in Platform Nov 24, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @GyuH13, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for the Dynamixel Easy SDK by integrating a complete Python manual. It introduces new, modular API reference pages for core SDK components, providing detailed information for both Python and C++ users. Furthermore, a series of new tutorials, ranging from basic single motor control to advanced group teleoperation, have been added for both languages, making the SDK more accessible and easier to use for a broader developer audience.

Highlights

  • Python Documentation Added: A comprehensive manual for the Dynamixel Easy SDK in Python has been introduced, covering API references and various control tutorials.
  • API Reference Restructuring: The API reference section has been reorganized into separate, language-specific pages for Connector, Motor, GroupExecutor, Data Types, and Error handling, supporting both Python and C++.
  • New Tutorials for Python & C++: New tutorials for both single motor control (steps 1-4) and group motor control (steps 5-7), including teleoperation examples, have been added with code snippets for both Python and C++.
  • Enhanced Getting Started Guide: The getting started guide has been updated to include Python SDK installation instructions and an interactive Python example.
  • Improved Error Handling Explanation: The SDK's introduction now clarifies the error handling mechanisms for both Python (unified exceptions) and C++ (result objects).
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request makes significant progress in adding Python documentation for the Easy SDK and restructuring the API reference. The use of tabs for different languages and splitting content into included files improves the documentation's organization. However, there are numerous instances where C++ documentation, code examples, and type definitions have been copied into Python-specific files, leading to incorrect and misleading information for Python users. I've pointed out these copy-paste errors and other inconsistencies in the documentation. Please review these comments to ensure the accuracy of the documentation for both languages.

Copy link
Member

@ola31 ola31 left a comment

Choose a reason for hiding this comment

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

Good

Copy link
Member

@yun-goon yun-goon left a comment

Choose a reason for hiding this comment

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

Good!

Copy link
Member

@sunghowoo sunghowoo left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@nhw-robotis nhw-robotis left a comment

Choose a reason for hiding this comment

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

Great work

Copy link
Member

@kimtaehyeong99 kimtaehyeong99 left a comment

Choose a reason for hiding this comment

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

GOOD!

@GyuH13 GyuH13 requested a review from robotpilot November 26, 2025 08:09
Copy link
Member

@robotpilot robotpilot left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for your dedicated efforts.

@GyuH13 GyuH13 merged commit 52b7a1a into master Nov 27, 2025
@GyuH13 GyuH13 deleted the feature-easy-sdk-python branch November 27, 2025 03:21
@github-project-automation github-project-automation bot moved this from 📝 Pull Request to 🚩Done in Platform Nov 27, 2025
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

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

9 participants