Skip to content
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

Merged
merged 13 commits into from
Oct 27, 2023
Merged

First attempt to add ergocub sw documentation #318

merged 13 commits into from
Oct 27, 2023

Conversation

martinaxgloria
Copy link
Member

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 both ergocub-head and ergocub-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

Copy link
Member

@pattacini pattacini left a comment

Choose a reason for hiding this comment

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

Hi @martinaxgloria

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.

docs/index.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@martinaxgloria
Copy link
Member Author

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

@martinaxgloria
Copy link
Member Author

Hi @pattacini,

As you proposed, I made some changes here 009b1e6

Copy link
Member

@pattacini pattacini left a 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.

@martinaxgloria
Copy link
Member Author

With b6f060e, I added other pieces of documentation and the references to the existing pages with the specs for ergocub.

cc @Nicogene @pattacini @traversaro

@traversaro
Copy link
Member

Thanks!

fyi @S-Dafarra @GiulioRomualdi

Copy link
Member

@Nicogene Nicogene left a comment

Choose a reason for hiding this comment

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

Reviewed irl, LGTM!

@Nicogene
Copy link
Member

@traversaro if it is ok for you we could merge it

@pattacini

This comment was marked as outdated.

@traversaro
Copy link
Member

fyi @isorrentino @mebbaid @lrapetti @CarlottaSartore @paolo-viceconte

pattacini

This comment was marked as resolved.

Copy link
Member

@pattacini pattacini left a 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/network.md Outdated Show resolved Hide resolved
docs/ergocub_operating_systems/network.md Outdated Show resolved Hide resolved
docs/icub_operating_systems/icubos/jetpack.md Outdated Show resolved Hide resolved
@pattacini
Copy link
Member

Hi @martinaxgloria

There are conflicting files needing your care.

I did it myself.

@pattacini
Copy link
Member

Some other quick suggested inline amendments.

Done!

@pattacini pattacini merged commit 529d748 into icub-tech-iit:master Oct 27, 2023
1 check passed
@pattacini pattacini linked an issue Oct 27, 2023 that may be closed by this pull request
@martinaxgloria
Copy link
Member Author

Thank you so much @pattacini!

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.

Document installation procedure for ergocub-head system
6 participants