Skip to content

Commit 15945a1

Browse files
authored
Merge pull request #7 from vanderbiltrobotics/mechE
test branch and pull request
2 parents c94325b + 2fa01a7 commit 15945a1

File tree

8 files changed

+55
-2
lines changed

8 files changed

+55
-2
lines changed

getting_started/commands.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Command Line Basics
44
A lot of work on the programming team involves the terminal so here is a quick reference for
55
getting comfortable with working in the terminal. Note that linux and macOS are both Unix operating systems.
66

7+
GREAT
8+
79
.. tabs::
810

911
.. group-tab:: Unix

index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@
1616
getting_started/git
1717
getting_started/best-practices
1818

19+
.. toctree::
20+
:caption: Mechanical
21+
:maxdepth: 2
22+
:hidden:
23+
24+
mechanical/intro.md
25+
mechanical/resources.rst
26+
mechancial/design-spec.rst
27+
mechanical/cad.rst
28+
mechanical/presentations.rst
29+
mechanical/system-design-review.rst
30+
1931
.. toctree::
2032
:caption: Intro Projects
2133
:maxdepth: 2

mechanical/cad.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
******************
2+
CAD
3+
******************
4+
5+
+------------------------+-----------------+------------------------+-----------------------------------------------------------------+
6+
| Title of Part | Author | File Location | Design Log |
7+
+========================+=================+========================+=================================================================+
8+
| example_part.SLDPRT | Rais Nurhidajat | Mechanical/CAD/Example |Example CAD part for demonstration. |
9+
+------------------------+-----------------+------------------------+-----------------------------------------------------------------+

mechanical/design-spec.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
******************
2+
Design Specs
3+
******************
4+
5+
To be updated...

mechanical/intro.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Intro to Mechanical Documentation
2-
This document provides a high level overview of how to complete documentation for the mechanical team.
1+
# Overview of Mechanical Documentation
2+
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.
33

44
## Resources
55
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
1010
4. Which subsystem the resource is most relevant for
1111

1212
## Design Specs
13+
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.
1314

1415
## CAD
16+
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.
17+
18+
## Presentations
19+
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.
1520

1621
## System Design Review
22+
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.

mechanical/presentations.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
******************
2+
Presentations
3+
******************
4+
5+
+--------------------------------------+-----------------+-----------------------------------------------------------------------------+
6+
| Title | Author | Description |
7+
+======================================+=================+=============================================================================+
8+
| Robotics Interest Meeting 8_28_2023 | Rais Nurhidajat | Overview of robotics club and interest meeting information. |
9+
+--------------------------------------+-----------------+-----------------------------------------------------------------------------+

mechanical/resources.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
******************
2+
Resources
3+
******************
4+
5+
To be updated.

mechanical/system-design-review

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
******************
2+
System Design Review
3+
******************
4+
5+
Add paragraphs here:

0 commit comments

Comments
 (0)