Merge pull request #7 from vanderbiltrobotics/mechE

RyanTaylor37 · web-flow · commit 15945a1cf2e3 · 2023-10-02T17:10:53.000-05:00
test branch and pull request
diff --git a/getting_started/commands.rst b/getting_started/commands.rst
@@ -4,6 +4,8 @@ Command Line Basics
 A lot of work on the programming team involves the terminal so here is a quick reference for 
 getting comfortable with working in the terminal. Note that linux and macOS are both Unix operating systems.
 
+GREAT
+
 .. tabs::
 
   .. group-tab:: Unix
diff --git a/index.rst b/index.rst
@@ -16,6 +16,18 @@
    getting_started/git
    getting_started/best-practices
 
+.. toctree::
+   :caption: Mechanical
+   :maxdepth: 2
+   :hidden:
+   
+   mechanical/intro.md
+   mechanical/resources.rst
+   mechancial/design-spec.rst
+   mechanical/cad.rst
+   mechanical/presentations.rst
+   mechanical/system-design-review.rst
+
 .. toctree::
    :caption: Intro Projects
    :maxdepth: 2
diff --git a/mechanical/cad.rst b/mechanical/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.                              |
++------------------------+-----------------+------------------------+-----------------------------------------------------------------+
diff --git a/mechanical/design-spec.rst b/mechanical/design-spec.rst
@@ -0,0 +1,5 @@
+******************
+Design Specs
+******************
+
+To be updated...
diff --git a/mechanical/intro.md b/mechanical/intro.md
@@ -1,5 +1,5 @@
-# Intro to Mechanical Documentation
-This document provides a high level overview of how to complete documentation for the mechanical team. 
+# Overview of Mechanical 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:
@@ -10,7 +10,13 @@ Each system should have background resources to facilitate brainstorming, genera
 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. 
diff --git a/mechanical/presentations.rst b/mechanical/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.                 |
++--------------------------------------+-----------------+-----------------------------------------------------------------------------+
diff --git a/mechanical/resources.rst b/mechanical/resources.rst
@@ -0,0 +1,5 @@
+******************
+Resources
+******************
+
+To be updated.
diff --git a/mechanical/system-design-review b/mechanical/system-design-review
@@ -0,0 +1,5 @@
+******************
+System Design Review
+******************
+
+Add paragraphs here:
