-
Notifications
You must be signed in to change notification settings - Fork 55
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
base: main
Are you sure you want to change the base?
Conversation
Hi @anujtaosf, can you fix this issue with the docs generation?
|
@senthurayyappan fixed compiling error opensourceleg/docs/tutorials/robots/getting_started.md Lines 92 to 94 in 15318e0
|
|
||
## Hardware Setup | ||
|
||
1. Cong |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something is missing here
There was a problem hiding this 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]>
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. |
No description provided.