Skip to content

Commit d104307

Browse files
RyanTaylor37RyanTaylor37
committed
adding electrical, programming, and how to rst guide
1 parent 15945a1 commit d104307

14 files changed

+280
-1
lines changed

‎electrical/cad.rst

+9
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+
+------------------------+-----------------+------------------------+-----------------------------------------------------------------+

‎electrical/design-spec.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
******************
2+
Design Specs
3+
******************
4+
5+
To be updated...

‎electrical/intro.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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.
3+
4+
## Resources
5+
Each system should have background resources to facilitate brainstorming, generate inspiration, and support design decisions. Resources should be added with the following method:
6+
7+
1. Link to resource
8+
2. Summary of resource
9+
3. Key points of useful information
10+
4. Which subsystem the resource is most relevant for
11+
12+
## 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.
14+
15+
## 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.
20+
21+
## 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.

‎electrical/presentations.rst

+9
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+
+--------------------------------------+-----------------+-----------------------------------------------------------------------------+

‎electrical/resources.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
******************
2+
Resources
3+
******************
4+
5+
To be updated.

‎electrical/system-design-review

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

‎index.rst

+33-1
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,35 @@
2323

2424
mechanical/intro.md
2525
mechanical/resources.rst
26-
mechancial/design-spec.rst
26+
mechanical/design-spec.rst
2727
mechanical/cad.rst
2828
mechanical/presentations.rst
2929
mechanical/system-design-review.rst
3030

31+
.. toctree::
32+
:caption: Electrical
33+
:maxdepth: 2
34+
:hidden:
35+
36+
electrical/intro.md
37+
electrical/resources.rst
38+
electrical/design-spec.rst
39+
electrical/cad.rst
40+
electrical/presentations.rst
41+
electrical/system-design-review.rst
42+
43+
.. toctree::
44+
:caption: Programming
45+
:maxdepth: 2
46+
:hidden:
47+
48+
programming/intro.md
49+
programming/resources.rst
50+
programming/design-spec.rst
51+
programming/cad.rst
52+
programming/presentations.rst
53+
programming/system-design-review.rst
54+
3155
.. toctree::
3256
:caption: Intro Projects
3357
:maxdepth: 2
@@ -121,3 +145,11 @@
121145
lidar/launchlocalization
122146
lidar/parameters
123147
lidar/localizationtheory
148+
149+
150+
.. toctree::
151+
:caption: Website RST Guide
152+
:maxdepth: 3
153+
:hidden:
154+
155+
rst/how-to-use-rst

‎programming/cad.rst

+9
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+
+------------------------+-----------------+------------------------+-----------------------------------------------------------------+

‎programming/design-spec.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
******************
2+
Design Specs
3+
******************
4+
5+
To be updated...

‎programming/intro.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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.
3+
4+
## Resources
5+
Each system should have background resources to facilitate brainstorming, generate inspiration, and support design decisions. Resources should be added with the following method:
6+
7+
1. Link to resource
8+
2. Summary of resource
9+
3. Key points of useful information
10+
4. Which subsystem the resource is most relevant for
11+
12+
## 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.
14+
15+
## 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.
20+
21+
## 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.

‎programming/presentations.rst

+9
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+
+--------------------------------------+-----------------+-----------------------------------------------------------------------------+

‎programming/resources.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
******************
2+
Resources
3+
******************
4+
5+
To be updated.

‎programming/system-design-review

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

‎rst/how-to-use-rst.rst

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
========================
2+
Technical Documentation
3+
========================
4+
5+
This is a template reStructuredText file that demonstrates various functionalities useful for technical documentation.
6+
7+
Section 1
8+
=========
9+
10+
Paragraphs and Line Breaks
11+
--------------------------
12+
13+
This is the first paragraph.
14+
15+
This is the second paragraph with a
16+
line break.
17+
18+
Text Formatting
19+
---------------
20+
21+
*Italic* text, **Bold** text, and ``Inline Code``.
22+
23+
Lists
24+
-----
25+
26+
Unordered List:
27+
28+
- Item 1
29+
- Item 2
30+
- Sub-item 1
31+
- Sub-item 2
32+
33+
Ordered List:
34+
35+
1. First item
36+
2. Second item
37+
1. Sub-item 1
38+
2. Sub-item 2
39+
40+
Section 2
41+
=========
42+
43+
Images
44+
------
45+
46+
.. image:: path/to/image.png
47+
:alt: Alternative text
48+
:width: 200px
49+
:align: center
50+
51+
Videos
52+
------
53+
54+
.. raw:: html
55+
56+
<iframe width="560" height="315" src="https://www.youtube.com/embed/VIDEO_ID" frameborder="0" allowfullscreen></iframe>
57+
58+
Links
59+
-----
60+
61+
Inline Link: `Link text <http://example.com>`_
62+
63+
Footnote Link: Link text [#]_.
64+
65+
.. [#] http://example.com
66+
67+
Tables
68+
------
69+
70+
Simple Table:
71+
72+
+----------+----------+
73+
| Header 1 | Header 2 |
74+
+==========+==========+
75+
| Cell 1 | Cell 2 |
76+
+----------+----------+
77+
| Cell 3 | Cell 4 |
78+
+----------+----------+
79+
80+
Grid Table:
81+
82+
.. table::
83+
84+
+----------+----------+
85+
| Header 1 | Header 2 |
86+
+==========+==========+
87+
| Cell 1 | Cell 2 |
88+
+----------+----------+
89+
| Cell 3 | Cell 4 |
90+
+----------+----------+
91+
92+
Code Blocks
93+
-----------
94+
95+
::
96+
97+
def function():
98+
print("This is a code block")
99+
100+
With Syntax Highlighting:
101+
102+
.. code-block:: python
103+
104+
def function():
105+
print("This is a code block with syntax highlighting")
106+
107+
Directives and Roles
108+
--------------------
109+
110+
.. note::
111+
112+
This is a note.
113+
114+
.. warning::
115+
116+
This is a warning.
117+
118+
References to a :term:`term`.
119+
120+
Summary Table
121+
-------------
122+
123+
+--------------+------------------------------------------------------------+----------------------------------------------+
124+
| **Element** | **Syntax Example** | **Description** |
125+
+--------------+------------------------------------------------------------+----------------------------------------------+
126+
| **Title** | ``Title Level 1\n===========`` | Creates a title or section header |
127+
| **Paragraph**| ``This is a paragraph.`` | Creates a paragraph |
128+
| **Italic** | ``*Italic*`` | Creates italic text |
129+
| **Bold** | ``**Bold**`` | Creates bold text |
130+
| **List** | ``- Item 1\n- Item 2`` | Creates an unordered list |
131+
| **Image** | ``.. image:: path/to/image.png\n :alt: Alt text`` | Embeds an image |
132+
| **Video** | ``.. raw:: html\n <iframe src="URL"></iframe>`` | Embeds a video |
133+
| **Link** | `` `Link text <http://example.com>`_ `` | Creates a hyperlink |
134+
| **Table** | ``+---+---+\n| H1 | H2 |\n+===+===+\n| C1 | C2 |\n+---+---+`` | Creates a simple table |
135+
| **Code** | ``::\n def func():\n print("code")`` | Creates a code block |
136+
| **Directive**| ``.. note::\n This is a note.`` | Adds special content like notes or warnings |
137+
+--------------+------------------------------------------------------------+----------------------------------------------+

0 commit comments

Comments
 (0)