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

Adding documentation about 3DMID mounting - hand mk5.1 #300

Merged
merged 10 commits into from
Aug 19, 2023

Conversation

simeonedussoni
Copy link
Member

Editiing of the hand mk5.1 documentation including new figures to show the state-of-the-art of fingertip mounting with the 3DMID parts and related

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 @simeonedussoni

The website is compiled using mkdocs, which slightly differs from markdown, especially for what regards the path of images. Indeed, all images are not displayed.

See the result:

FireShot Capture 025 - Fingertip skin and MMA board - iCub Tech Docs_ - 8000-simeoneduss-documentati-v4uuz4ljycq ws-eu104 gitpod io

Important

You ought to compile the website for your fork, following the instructions in the main README. You may stick to the option GitHub Pages on Forks.

A few other points to address:

  • We tend to keep image size less than 1 MB.
  • Bullet points ordering is broken and needs fixing.
  • Use admonitions for notes.

docs/hands/fingertip_and_mma_mk5.md Outdated Show resolved Hide resolved
docs/hands/fingertip_and_mma_mk5.md Outdated Show resolved Hide resolved
docs/hands/img/3dMID_fixed.png Outdated Show resolved Hide resolved
docs/hands/img/insertion.png Outdated Show resolved Hide resolved
docs/hands/fingertip_and_mma_mk5.md 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.

Thanks for the amendments!

@pattacini pattacini merged commit 1746fb4 into icub-tech-iit:master Aug 19, 2023
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.

2 participants