refactor(ATOM-HW-1): Creates Hardware Guide section #25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduced comprehensive documentation for Arduino Uno, ESP32 (including ESP32-CAM), and Raspberry Pi. Added introductory guides, programming instructions, basic code examples, and hardware overviews for each platform to support new users and streamline onboarding.
Added overview documentation for buttons, LEDs, motors, potentiometers, and resistors in the Components section. Introduced Raspberry Pi 4 Model B documentation, including basic Python GPIO examples, and added an overview for Raspberry Pi Zero 2 W. These additions expand the hardware guide with foundational reference material for common electronic components and Raspberry Pi boards.
Added new tutorial markdown files for various hardware components (Buttons, LEDs, Motors, Potentiometers, Resistors, Sensors) and microcontroller/computer boards (Arduino Uno, ESP32, Raspberry Pi 4, Raspberry Pi Zero 2 W). Included detailed example projects and code for Arduino, ESP32, and Raspberry Pi platforms. Removed old Raspberry Pi Zero 2 W overview and .keep files, replacing them with updated overview and tutorial content.
Renamed and relocated hardware guide documentation files from the '3D/hardware_guide' directory to 'hardware_guide' to simplify the directory structure and improve organization. No content changes were made to the files.
Renamed and reorganized various 3D model and documentation files from the root 3D directory into the Projects/3D directory structure for better organization and clarity.
Introduced overview and tutorial markdown files for 3D Printing, CAD, Power, Screens, Sensors, and Servos in the hardware guide. Expanded and updated tutorial links for Buttons, LEDs, Motors, Potentiometers, Resistors, and Sensors. Added a practice guide for servos with example Arduino code. These additions provide structured documentation and learning resources for hardware components in the project.
Removed redundant and outdated tutorial files for Arduino, ESP32, and Raspberry Pi boards. Consolidated and updated tutorial links in central 'tutorials/tutorials.md' files for Arduino and ESP32, and updated the ESP32-CAM pinout image. This improves organization and ensures up-to-date resources are provided.
Introduces a README file in the hardware_guide directory, providing an overview of electronic components, microcontrollers, computers, and architecting tools used in the Atom Project. This guide is intended to help newcomers understand the project's hardware ecosystem and navigate related documentation.
Added circuitDiagram.png to the media directory and updated the tutorials.md file to reference the local image instead of an external URL. This improves documentation reliability and ensures the diagram is available offline.
|
Validation Failed! The branch name and PR title must follow the
Please adjust and try again. Thank you! |
oEnzoRibas
changed the title
oEnzoRibas
requested review from
Joaoavr,
Rafaaalvess,
nicolasgarcia4 and
pedrolucasvsr
oEnzoRibas
added
documentation
pedrolucasvsr
left a comment
pedrolucasvsr
left a comment
There was a problem hiding this comment.
Todos os links funcionando, seria bom ordená-los em tópicos (no momento estão alinhados).
Nos arquivos abaixo há imagens que não foram carregadas:
- hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/basicExemples.md/tutorials.md
- hardware_guide/MicroControllers_Computers/Arduino/arduinoUno/overview.md
- hardware_guide/MicroControllers_Computers/ESP32/ESP32CAM/overview.md
Member
Author
Bom dia, @pedrolucasvsr ! Você abriu o arquivo por onde? O melhor é sempre clonar o repositorio para revisar. Mas mesmo no github web as imagens aparecem. 
|
nicolasgarcia4
approved these changes
Sep 2, 2025
Rafaaalvess
approved these changes
Sep 2, 2025
pedrolucasvsr
approved these changes
Sep 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces comprehensive introductory documentation for several key hardware components and concepts relevant to robotics and electronics projects. The main focus is on providing clear, beginner-friendly overviews and practical guidance for components such as buttons, LEDs, motors, potentiometers, power systems, as well as foundational topics like CAD and 3D printing. Additionally, curated tutorial links are provided for hands-on learning.
Component Overviews and Technical Explanations:
hardware_guide/Components/Buttons/overview.md)hardware_guide/Components/LEDs/overview.md)hardware_guide/Components/Motors/overview.md)hardware_guide/Components/Potentiometers/overview.md)hardware_guide/Components/Power/overview.md)Foundational Concepts:
hardware_guide/Archtecting/3D Printing/overview.md)hardware_guide/Archtecting/CAD/overview.md)Tutorial and Learning Resources:
hardware_guide/Components/Buttons/tutorials.md)hardware_guide/Components/LEDs/tutorials.md)hardware_guide/Components/Motors/tutorials.md)hardware_guide/Components/Potentiometers/tutorials.md)hardware_guide/Archtecting/CAD/tutorials.md)These changes significantly improve the accessibility and educational value of the hardware guide for new team members and beginners.