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

ergoCub_battery_pack folder created with a documentation #392

Merged
merged 16 commits into from
Jan 30, 2025

Conversation

andresoll
Copy link
Member

This PR adds the following changes:

  1. Update in .md
  2. Correct visualization from the website
  3. Generated index via mkdocs

Small error update in .md format
Changes required for correct visualization from the website
generated index via mkdocs
@andresoll andresoll requested a review from pattacini as a code owner January 28, 2025 10:39
@andresoll andresoll requested a review from valegagge January 28, 2025 10:40
@andresoll andresoll self-assigned this Jan 28, 2025
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 @andresoll

The doc looks awesome at a first glance ✨
I'll have a deeper look later. In the meantime, please just keep the image size smaller that 1 MB.

docs/ergoCub_battery_pack/assets/battery_general.png Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/assets/locker_battery.png Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/assets/recharger_station.png Outdated Show resolved Hide 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 inline suggestions to help read the text more fluently plus some formatting mods.

Note

You can accept and commit the suggestions straight away from the corresponding GUI button.

docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
@pattacini pattacini linked an issue Jan 28, 2025 that may be closed by this pull request
Copy link
Member

@valegagge valegagge left a comment

Choose a reason for hiding this comment

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

hi @andresoll ,

excellent work!!! I requested some minor changes. thanks

docs/ergoCub_battery_pack/ergoCub_battery_pack.md Outdated Show resolved Hide resolved
docs/ergoCub_battery_pack/index.md Show resolved Hide resolved
andresoll and others added 14 commits January 29, 2025 11:12
Copy link
Member

@valegagge valegagge left a comment

Choose a reason for hiding this comment

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

ok, after the image will be updated with size less than 1MB

@andresoll
Copy link
Member Author

Hi @pattacini
I changed the size of the images, sorry I had forgotten to do that!

@valegagge

@pattacini
Copy link
Member

Thanks!

@pattacini pattacini merged commit e30ca96 into icub-tech-iit:master Jan 30, 2025
1 check passed
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.

Publish the documentation regarding the new ergocub Battery Pack
3 participants