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.

Sign up for GitHub

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

Jump to bottom

adding electrical category #8

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

adding electrical category #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ec650a
adding electrical category
RyanTaylor37 Oct 2, 2023
7b77a10
adding electrical to index
RyanTaylor37 Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions eletrical /cad.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
******************
CAD
******************

+------------------------+-----------------+------------------------+-----------------------------------------------------------------+
| Title of Part | Author | File Location | Design Log |
+========================+=================+========================+=================================================================+
| example_part.SLDPRT | Rais Nurhidajat | Mechanical/CAD/Example |Example CAD part for demonstration. |
+------------------------+-----------------+------------------------+-----------------------------------------------------------------+
5 changes: 5 additions & 0 deletions eletrical /design-spec.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
Design Specs
******************

To be updated...
22 changes: 22 additions & 0 deletions eletrical /intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Overview of Electrical Documentation
This document provides a high level overview of how to complete documentation for the mechanical team. See the below sections for more information about how to update the Resources, Design Specs, CAD, Presentations, and System Design Review pages.

## Resources
Each system should have background resources to facilitate brainstorming, generate inspiration, and support design decisions. Resources should be added with the following method:

1. Link to resource
2. Summary of resource
3. Key points of useful information
4. Which subsystem the resource is most relevant for

## Design Specs
The overall design and every piece of hardware should have an explanation of part characteristics. This section is for documenting motor specs, sensor specs, dimensions, design spec requirements, etc. Each spec should also have a short justification for why it was chosen to asist in educating future members about how to make their design decisions. Use charts and diagrams as much as possible along with paragraph explanations for the justifications.

## CAD
All CAD will be conducted in SolidWorks. This page is for logging CAD changes between teammates. Each entry should have the title of part, who modified/created the part, where it is on Google Drive, a log of what was edited and why.

## Presentations
All presentations should be uploaded to the VURobotics Google Drive. Presentation titles should have dates. This page will log name of presentation, presentation authors, and brief explanation of what the presentation covers.

## System Design Review
After every presentation, information should be condensed into a paragraph or two that will eventually be integrated into a System Design Review paper and submitted to NASA. Figures should be included and made to a professional standard.
9 changes: 9 additions & 0 deletions eletrical /presentations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
******************
Presentations
******************

+--------------------------------------+-----------------+-----------------------------------------------------------------------------+
| Title | Author | Description |
+======================================+=================+=============================================================================+
| Robotics Interest Meeting 8_28_2023 | Rais Nurhidajat | Overview of robotics club and interest meeting information. |
+--------------------------------------+-----------------+-----------------------------------------------------------------------------+
5 changes: 5 additions & 0 deletions eletrical /resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
Resources
******************

To be updated.
5 changes: 5 additions & 0 deletions eletrical /system-design-review
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
System Design Review
******************

Add paragraphs here:
12 changes: 12 additions & 0 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@
mechanical/presentations.rst
mechanical/system-design-review.rst

.. toctree::
:caption: Electrical
:maxdepth: 2
:hidden:

electrical/intro.md
electrical/resources.rst
electrical/design-spec.rst
electrical/cad.rst
electrical/presentations.rst
electrical/system-design-review.rst

.. toctree::
:caption: Intro Projects
:maxdepth: 2
Expand Down