-
Notifications
You must be signed in to change notification settings - Fork 35
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
First attempt to add ergocub sw documentation #318
Conversation
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.
Thanks for the nice addition 👍🏻
I would avoid creating a dedicated overall section to ergoCub at that major level.
There is already lots of stuff dedicated to this new robot that lies within the HW and SW sections, which are meant to comprise everything, although they contain the keyword iCub
.
So, my suggestion is to go with dedicated ergoCub pages that need to be created in the section related to the SW installation.
Possibly, in the future, we will aim to take on a major overhaul of the section/page naming conventions.
Hi @pattacini, I got the point. I'll remove the major section I've created and I'll move the pages under the iCub software section |
Hi @pattacini, As you proposed, I made some changes here 009b1e6 |
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.
Cool!
@martinaxgloria, I reckon you can now proceed with filling out the missing parts, sticking to this skeleton.
With b6f060e, I added other pieces of documentation and the references to the existing pages with the specs for ergocub. |
Thanks! |
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.
Reviewed irl, LGTM!
@traversaro if it is ok for you we could merge it |
This comment was marked as outdated.
This comment was marked as outdated.
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.
Some other quick suggested inline amendments.
docs/ergocub_operating_systems/ergocub_torso/install_from_scratch.md
Outdated
Show resolved
Hide resolved
docs/ergocub_operating_systems/ergocub_torso/install_from_scratch.md
Outdated
Show resolved
Hide resolved
I did it myself. |
Done! |
Thank you so much @pattacini! |
Since #282, I'd like to add a new section within
icub-tech documentation
that would be specific for ergocub software (like for icub hw and icub sw). My idea is to document the installation of bothergocub-head
andergocub-torso
and the specific procedures and modules for each of them (e.g. librealsense installation for ergocub-head), the ergocub network specs (made by @davidelasagna) and other stuff that are not completely linked to icub documentation.In this PR, I proposed a potential new layout with some sections already filled in thanks to @davidelasagna.
cc @Nicogene @pattacini @traversaro