Skip to content

Conversation

@telles-lucas
Copy link
Contributor

Aqui foi estruturado o README para a parte de hardware do projeto. Primeiramente foram citados os componentes das partes que serão impressas por filamento 3D, depois componentes eletrônicos a serem adquiridos e, por fim, os produtos necessários para a parte de colagem e acabamento final

Aqui foi estruturado o README para a parte de hardware do projeto. Primeiramente foram citados os componentes das partes que serão impressas por filamento 3D, depois componentes eletrônicos a serem adquiridos e, por fim, os produtos necessários para a parte de colagem e acabamento final
@github-actions
Copy link

Validation Failed!

The branch name and PR title must follow the ATOM-HW- pattern.

  • Ensure the branch name starts with ATOM-HW-.
  • Ensure the PR title contains ATOM-HW-.

Please adjust and try again. Thank you!

Copy link

Copilot AI left a 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 restructures the README for the hardware section of the project by clearly listing the 3D printed parts, electronic components, and additional assembly details.

  • Introduces a new "Mechanical Arm Structure" section with categorized parts such as fingers, structures, and complementary parts.
  • Adds detailed sections for "Electronic Components," "Assembly Materials," "Technical Notes," and "Credits."
Comments suppressed due to low confidence (6)

README.md:8

  • The term 'Majeure' is ambiguous; consider updating it to 'Middle Finger' to maintain clarity and consistency with the explanatory text.
  - Majeure (Middle Finger)

README.md:9

  • [nitpick] The naming 'RingFinger' could be made clearer by inserting a space to read as 'Ring Finger', aligning with typical naming conventions.
  - RingFinger

README.md:13

  • [nitpick] The identifier 'Wristlarge' is inconsistent; consider renaming it to 'Large Wrist' or 'wristLarge' to match the descriptive text and improve clarity.
  - Wristlarge (Large Wrist)

README.md:14

  • [nitpick] Similar to 'Wristlarge', 'Wristsmall' would be clearer if renamed to 'Small Wrist' or 'wristSmall' to ensure consistent naming across components.
  - Wristsmall (Small Wrist)

README.md:15

  • [nitpick] The naming 'topsurface' is inconsistent in format; consider changing it to 'Top Surface' or using camelCase (e.g., 'topSurface') for consistency with other component names.
  - topsurface (Top Surface)

README.md:16

  • [nitpick] The identifier 'coverfinger' is less clear compared to 'Finger Cover'; standardizing the naming format (e.g., 'Finger Cover' or 'coverFinger') would improve readability.
  - coverfinger (Finger Cover)

@oEnzoRibas oEnzoRibas changed the title README.md ATOM-HARD: Atualizando Readme.md May 22, 2025
@oEnzoRibas oEnzoRibas added the documentation Improvements or additions to documentation label May 22, 2025
@github-actions
Copy link

Validation Failed!

The branch name and PR title must follow the ATOM-HW- pattern.

  • Ensure the branch name starts with ATOM-HW-.
  • Ensure the PR title contains ATOM-HW-.

Please adjust and try again. Thank you!

@oEnzoRibas oEnzoRibas linked an issue May 22, 2025 that may be closed by this pull request
@oEnzoRibas oEnzoRibas removed their request for review May 29, 2025 21:03
Copy link
Member

@oEnzoRibas oEnzoRibas left a comment

Choose a reason for hiding this comment

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

Adicionar seção explicando como o repositório de Hardware funciona:

  • intuito
  • Estrutura de pastas
  • e como instalar esse repositório localmente.

Essa parte descrevendo o projeto do braco mecanico pode ficar em uma pasta dentro do repositório ao invés do Read.me

@oEnzoRibas oEnzoRibas closed this Jun 20, 2025
@oEnzoRibas oEnzoRibas deleted the telles-lucas-patch-1 branch June 20, 2025 16:01
@oEnzoRibas oEnzoRibas removed a link to an issue Jun 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants