From 7ec650a24e9a25b91311fbe52dd30aa96e87da54 Mon Sep 17 00:00:00 2001 From: Ryan Taylor Date: Mon, 2 Oct 2023 17:17:10 -0500 Subject: [PATCH 1/2] adding electrical category --- eletrical /cad.rst | 9 +++++++++ eletrical /design-spec.rst | 5 +++++ eletrical /intro.md | 22 ++++++++++++++++++++++ eletrical /presentations.rst | 9 +++++++++ eletrical /resources.rst | 5 +++++ eletrical /system-design-review | 5 +++++ 6 files changed, 55 insertions(+) create mode 100644 eletrical /cad.rst create mode 100644 eletrical /design-spec.rst create mode 100644 eletrical /intro.md create mode 100644 eletrical /presentations.rst create mode 100644 eletrical /resources.rst create mode 100644 eletrical /system-design-review diff --git a/eletrical /cad.rst b/eletrical /cad.rst new file mode 100644 index 0000000..82109d5 --- /dev/null +++ b/eletrical /cad.rst @@ -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. | ++------------------------+-----------------+------------------------+-----------------------------------------------------------------+ \ No newline at end of file diff --git a/eletrical /design-spec.rst b/eletrical /design-spec.rst new file mode 100644 index 0000000..b46d620 --- /dev/null +++ b/eletrical /design-spec.rst @@ -0,0 +1,5 @@ +****************** +Design Specs +****************** + +To be updated... \ No newline at end of file diff --git a/eletrical /intro.md b/eletrical /intro.md new file mode 100644 index 0000000..9d64b09 --- /dev/null +++ b/eletrical /intro.md @@ -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. \ No newline at end of file diff --git a/eletrical /presentations.rst b/eletrical /presentations.rst new file mode 100644 index 0000000..23112db --- /dev/null +++ b/eletrical /presentations.rst @@ -0,0 +1,9 @@ +****************** +Presentations +****************** + ++--------------------------------------+-----------------+-----------------------------------------------------------------------------+ +| Title | Author | Description | ++======================================+=================+=============================================================================+ +| Robotics Interest Meeting 8_28_2023 | Rais Nurhidajat | Overview of robotics club and interest meeting information. | ++--------------------------------------+-----------------+-----------------------------------------------------------------------------+ \ No newline at end of file diff --git a/eletrical /resources.rst b/eletrical /resources.rst new file mode 100644 index 0000000..22db7a1 --- /dev/null +++ b/eletrical /resources.rst @@ -0,0 +1,5 @@ +****************** +Resources +****************** + +To be updated. \ No newline at end of file diff --git a/eletrical /system-design-review b/eletrical /system-design-review new file mode 100644 index 0000000..588d50f --- /dev/null +++ b/eletrical /system-design-review @@ -0,0 +1,5 @@ +****************** +System Design Review +****************** + +Add paragraphs here: \ No newline at end of file From 7b77a10bc6fa2cafe302c2ffa52233b97e802df3 Mon Sep 17 00:00:00 2001 From: Ryan Taylor Date: Mon, 2 Oct 2023 17:22:33 -0500 Subject: [PATCH 2/2] adding electrical to index --- index.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/index.rst b/index.rst index ec789f4..6aa0cdb 100644 --- a/index.rst +++ b/index.rst @@ -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