Skip to content

Commit

Permalink
refactor(docs): update documentation structure
Browse files Browse the repository at this point in the history
Simplified the documentation by removing redundant sections and
replacing them with direct links to component documentation.
Updated submodule references to point to the latest commits,
ensuring the documentation reflects the current state of the
project. This change aims to streamline the user experience
and improve maintainability.
  • Loading branch information
yiwenlu66 committed Jan 26, 2025
1 parent 6f7653d commit 1eaaa51
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 117 deletions.
2 changes: 1 addition & 1 deletion dexrobot_mujoco
Submodule dexrobot_mujoco updated from adad8a to 17e85e
2 changes: 1 addition & 1 deletion dexrobot_urdf
Submodule dexrobot_urdf updated from 42fa91 to 063e50
1 change: 0 additions & 1 deletion docs/components/dexrobot_urdf

This file was deleted.

1 change: 0 additions & 1 deletion docs/components/pyzlg_dexhand

This file was deleted.

1 change: 0 additions & 1 deletion docs/components/ros_compat

This file was deleted.

114 changes: 4 additions & 110 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,114 +5,8 @@ A software development kit for the control and simulation of the DexRobot dexter

.. toctree::
:maxdepth: 2
:caption: Contents
:caption: Component Documentation Links

.. toctree::
:maxdepth: 2
:caption: Component Documentation

components/pyzlg_dexhand/index
components/dexrobot_urdf/index
components/ros_compat/index

Getting Started
----------------

1. Make sure you have Git LFS installed::

sudo apt install git-lfs # For Ubuntu, for example
git lfs install

2. Clone the repository::

git clone --recursive https://gitee.com/DexRobot/dexrobot_python_sdk.git

.. note::
Make sure you have the ``--recursive`` flag turned on, so that all the submodules can be loaded. Alternatively, you can clone the submodules you need individually.

Project Components
-------------------

pyzlg_dexhand
~~~~~~~~~~~~~~
Low-level hardware interface and control library for the DexHand robotic system.

* Hardware communication via USB-CAN interface
* Protocol implementation for hand control
* ROS integration examples
* Visualization tools
* Comprehensive testing suite

dexrobot_kinematics
~~~~~~~~~~~~~~~~~~~
Kinematics library for robotic hand systems.

* Forward and inverse kinematics for hand configurations
* Support for both left and right hand variants
* Utilities for transformation and visualization
* Type-safe implementation with comprehensive testing

dexrobot_isaac
~~~~~~~~~~~~~~
Isaac Sim integration and simulation environment.

* Complex scene creation and simulation
* Integration with OpenAI Gym-style environments
* Support for various manipulation tasks
* Reinforcement learning infrastructure
* Pre-built assets and environments:
* Robotic hand models
* Furniture and object models
* Scene compositions
* Training configurations

dexrobot_urdf
~~~~~~~~~~~~~~
URDF (Unified Robot Description Format) models and utilities.

* Complete URDF descriptions for DexHand
* Mesh files for visualization and collision
* Utilities for URDF manipulation and analysis
* Both detailed and simplified hand models
* CAD exports in STEP format

dexrobot_mujoco
~~~~~~~~~~~~~~~~
MuJoCo simulation environment and utilities.

* MuJoCo XML models for the DexHand
* Scene creation tools
* Real-time visualization
* Physics-based simulation
* Integration with ROS
* Rich set of demo environments and furniture models

ros_compat
~~~~~~~~~~~
ROS compatibility layer for platform-independent development.

* Abstract interface for ROS functionality
* Logging utilities
* Time handling
* Node implementation

Installation
-------------

Please refer to the guides in the individual submodules.

Dependencies
-------------

* Python 3.6+
* ROS (optional, for ROS integration)
* MuJoCo (for physics simulation)
* Isaac Sim (for advanced simulation)
* USB-CAN adapter (for hardware control)

Indices and tables
================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
DexHand Control <https://dexrobot.github.io/pyzlg_dexhand/index.html>
URDF Models <https://dexrobot.github.io/dexrobot_urdf/index.html>
MuJoCo Simulation <https://dexrobot.github.io/dexrobot_mujoco/index.html>
2 changes: 1 addition & 1 deletion pyzlg_dexhand
Submodule pyzlg_dexhand updated from ebb40c to 316575
2 changes: 1 addition & 1 deletion ros_compat
Submodule ros_compat updated from 1e78ed to e7445f

0 comments on commit 1eaaa51

Please sign in to comment.