Skip to content

OSL documentation added for Robots module #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

anujtaosf
Copy link
Contributor

No description provided.

@anujtaosf anujtaosf linked an issue Jun 2, 2025 that may be closed by this pull request
@anujtaosf anujtaosf requested a review from senthurayyappan June 2, 2025 19:38
@senthurayyappan
Copy link
Member

Hi @anujtaosf, can you fix this issue with the docs generation?

INFO    -  Building documentation to directory: /home/runner/work/opensourceleg/opensourceleg/site
WARNING -  Doc file 'tutorials/robots/getting_started.md' contains a link 'reading_sensor_data.md', but the target 'tutorials/robots/reading_sensor_data.md' is not found among documentation files.
WARNING -  Doc file 'tutorials/robots/getting_started.md' contains a link 'commanding_voltage.md', but the target 'tutorials/robots/commanding_voltage.md' is not found among documentation files.
WARNING -  Doc file 'tutorials/robots/getting_started.md' contains a link 'commanding_current.md', but the target 'tutorials/robots/commanding_current.md' is not found among documentation files.
WARNING -  Doc file 'tutorials/robots/getting_started.md' contains a link 'commanding_position.md', but the target 'tutorials/robots/commanding_position.md' is not found among documentation files.
WARNING -  Doc file 'tutorials/robots/getting_started.md' contains a link 'commanding_impedance.md', but the target 'tutorials/robots/commanding_impedance.md' is not found among documentation files.

Aborted with 5 warnings in strict mode!
Error: Process completed with exit code 1.

@anujtaosf anujtaosf closed this Jun 4, 2025
@anujtaosf anujtaosf reopened this Jun 4, 2025
@anujtaosf
Copy link
Contributor Author

@senthurayyappan fixed compiling error

Choose a tutorial to get started:
- [Home OSL Joints](homing_joints.md)


## Hardware Setup

1. Cong
Copy link
Member

Choose a reason for hiding this comment

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

Something is missing here

@senthurayyappan senthurayyappan requested a review from Copilot June 22, 2025 14:09
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds documentation for the Robots module in the OSL project, including a Getting Started guide and a Homing Joints tutorial, and updates the site navigation.

  • Introduces a new “Robots” section in the mkdocs navigation
  • Adds getting_started.md for basic setup and safety guidelines
  • Adds homing_joints.md to walk through the joint homing procedure

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
mkdocs.yml Added “Robots” nav entry
docs/tutorials/robots/getting_started.md New Getting Started guide
docs/tutorials/robots/homing_joints.md New Homing OSL Joints tutorial
Comments suppressed due to low confidence (1)

mkdocs.yml:34

  • Indentation of the '- Robots:' entry is misaligned compared to other top-level nav items. It should use the same number of spaces as '- Utilities:' (and its siblings) so that the Robots section renders correctly.
      - Robots:

Taking copilot suggestion

Co-authored-by: Copilot <[email protected]>
@tkevinbest
Copy link
Member

Hey @anujtaosf - this looks great, but it would be good if we can remove some of the AI fluff in the docs. I don't think we need the entire "safety guidelines" section. I was talking to @senthurayyappan about this yesterday, where I feel like too much of our documentation is obviously AI generated and it makes me not want to reference the docs because it doesn't actually tell me many useful things.

The Homing Joints tutorial you made is great and much more along the lines of what I think we're looking for. Even there, we could add more explanation as to why things are implemented the way they are, rather than just how they're implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding Documentation for "robots"
3 participants