vanderbiltrobotics · RyanTaylor37 · Jun 20, 2024 · Jun 20, 2024 · Jun 20, 2024 · Jun 20, 2024
diff --git a/README.rst b/README.rst
@@ -23,6 +23,17 @@ Building From Source
     If you added something to the table of contents in :code:`index.rst` and it is not showing 
     up after you build, run :code:`make clean` and then :code:`make html` 
 
+Deploying Changes to Website
+--------------------
+Instructions to making edits and revisions to website 
+
+* Make github branch of repository
+* Add changes to branch and push to github
+* Make a pull request of branch into main
+    * Pull Request will generate a temporary web link to view changes to the website
+* Resolve conflicts of branch with main 
+* Merge pull requests and all changes will go live
+
 Contributing
 ------------
 Contributing to the ROS2 version of our code requires you to

diff --git a/electrical/cad.rst b/electrical/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/electrical/design-spec.rst b/electrical/design-spec.rst
@@ -0,0 +1,5 @@
+******************
+Design Specs
+******************
+
+To be updated...
diff --git a/electrical/intro.md b/electrical/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. 
diff --git a/electrical/presentations.rst b/electrical/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/electrical/resources.rst b/electrical/resources.rst
@@ -0,0 +1,5 @@
+******************
+Resources
+******************
+
+To be updated.
diff --git a/electrical/system-design-review b/electrical/system-design-review
@@ -0,0 +1,5 @@
+******************
+System Design Review
+******************
+
+Add paragraphs here:
diff --git a/index.rst b/index.rst
@@ -23,11 +23,35 @@
 
    mechanical/intro.md
    mechanical/resources.rst
-   mechancial/design-spec.rst
+   mechanical/design-spec.rst
    mechanical/cad.rst
    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: Programming
+   :maxdepth: 2
+   :hidden:
+
+   programming/intro.md
+   programming/resources.rst
+   programming/design-spec.rst
+   programming/cad.rst
+   programming/presentations.rst
+   programming/system-design-review.rst
+
 .. toctree::
    :caption: Intro Projects
    :maxdepth: 2
@@ -121,3 +145,11 @@
    lidar/launchlocalization
    lidar/parameters
    lidar/localizationtheory
+
+
+.. toctree::
+   :caption: Website RST Guide
+   :maxdepth: 3
+   :hidden:
+
+   rst/how-to-use-rst
diff --git a/programming/cad.rst b/programming/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/programming/design-spec.rst b/programming/design-spec.rst
@@ -0,0 +1,5 @@
+******************
+Design Specs
+******************
+
+To be updated...
diff --git a/programming/intro.md b/programming/intro.md
@@ -0,0 +1,22 @@
+# 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:
+
+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. 
diff --git a/programming/presentations.rst b/programming/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/programming/resources.rst b/programming/resources.rst
@@ -0,0 +1,5 @@
+******************
+Resources
+******************
+
+To be updated.
diff --git a/programming/system-design-review b/programming/system-design-review
@@ -0,0 +1,5 @@
+******************
+System Design Review
+******************
+
+Add paragraphs here:
diff --git a/rst/how-to-use-rst.rst b/rst/how-to-use-rst.rst
@@ -0,0 +1,165 @@
+========================
+Technical Documentation
+========================
+
+This is a template reStructuredText file that demonstrates various functionalities useful for technical documentation.
+
+Section 1
+=========
+
+Paragraphs and Line Breaks
+--------------------------
+
+This is the first paragraph.
+
+This is the second paragraph with a  
+line break.
+
+Text Formatting
+---------------
+
+*Italic* text, **Bold** text, and ``Inline Code``.
+
+Lists
+-----
+
+Unordered List:
+
+- Item 1
+- Item 2
+    - Sub-item 1
+    - Sub-item 2
+
+Ordered List:
+
+1. First item
+2. Second item
+    1. Sub-item 1
+    2. Sub-item 2
+
+
+Section 2
+=========
+
+Images
+------
+
+.. image:: scratch_cat.png
+   :alt: Alternative text
+   :width: 200px
+   :align: center
+
+Videos
+------
+
+.. raw:: html
+
+    <iframe width="560" height="315" src="https://www.youtube.com/watch?v=DSIuLnoKLd8" frameborder="0" allowfullscreen></iframe>
+
+Links
+-----
+
+Inline Link: `RST Tutorial <https://sphinx-tutorial.readthedocs.io/step-1/>`_
+
+Footnote Link: Link text [#]_.
+
+.. [#] https://sphinx-tutorial.readthedocs.io/start/
+
+Tables
+------
+
+Simple Table:
+
++----------+----------+
+| Header 1 | Header 2 |
++==========+==========+
+| Cell 1   | Cell 2   |
++----------+----------+
+| Cell 3   | Cell 4   |
++----------+----------+
+
+Grid Table:
+
+.. table::
+
+   +----------+----------+
+   | Header 1 | Header 2 |
+   +==========+==========+
+   | Cell 1   | Cell 2   |
+   +----------+----------+
+   | Cell 3   | Cell 4   |
+   +----------+----------+
+
+Code Blocks
+-----------
+
+::
+
+   def function():
+       print("This is a code block")
+
+With Syntax Highlighting:
+
+.. code-block:: python
+
+   def function():
+       print("This is a code block with syntax highlighting")
+
+Directives and Roles
+--------------------
+
+.. note::
+
+   This is a note.
+
+.. warning::
+
+   This is a warning.
+
+References to a :term:`term`.
+
+Summary Table
+-------------
+
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Element**  | **Syntax Example**                                         | **Description**                              |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Title**    | ``Title Level 1\n===========``                             | Creates a title or section header            |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Paragraph**| ``This is a paragraph.``                                   | Creates a paragraph                          |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Italic**   | ``*Italic*``                                               | Creates italic text                          |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Bold**     | ``**Bold**``                                               | Creates bold text                            |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **List**     | ``- Item 1\n- Item 2``                                     | Creates an unordered list                    |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Image**    | ``.. image:: path/to/image.png\n   :alt: Alt text``        | Embeds an image                              |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Video**    | ``.. raw:: html\n   <iframe src="URL"></iframe>``          | Embeds a video                               |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Link**     | `` `Link text <http://example.com>`_ ``                    | Creates a hyperlink                          |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Table**    | ``+---+---+\n| H1 | H2 |\n+===+===+\n| C1 | C2 |\n+---+---+`` | Creates a simple table                       |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Code**     | ``::\n   def func():\n       print("code")``               | Creates a code block                         |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Directive**| ``.. note::\n   This is a note.``                          | Adds special content like notes or warnings  |
++--------------+------------------------------------------------------------+----------------------------------------------+
+
+
+Minimal Example
+
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Element**  | **Syntax Example**                                         | **Description**                              |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Title**    | ``Title Level 1\n===========``                             | Creates a title or section header            |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Paragraph**| ``This is a paragraph.``                                   | Creates a paragraph                          |
++--------------+------------------------------------------------------------+----------------------------------------------+
+| **Italic**   | ``*Italic*``                                               | Creates italic text                          |
++--------------+------------------------------------------------------------+----------------------------------------------+
+
+
+
+
diff --git a/rst/scratch_cat.png b/rst/scratch_cat.png