neurobionics / opensourceleg

An open-source software library for numerical computation, data acquisition, and control of lower-limb robotic prostheses.
https://opensourceleg.org
GNU Lesser General Public License v2.1
32 stars 37 forks source link

Update docstrings and overall documentation with mermaid charts #292

Open senthurayyappan opened 2 weeks ago

senthurayyappan commented 2 weeks ago

🔈 Motivation

The current documentation for the opensourceleg library does not fully reflect the updated functionalities of the functions within the library. Additionally, the charts that describe the architecture and structure of the library are outdated. Updating the docstrings and overall documentation, including the main README, will ensure that users have accurate and up-to-date information, making the library easier to use and understand.