Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding electrical, programming, and how to rst guide #9

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions electrical/cad.rst
Original file line number Diff line number Diff line change
@@ -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. |
+------------------------+-----------------+------------------------+-----------------------------------------------------------------+
5 changes: 5 additions & 0 deletions electrical/design-spec.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
Design Specs
******************

To be updated...
22 changes: 22 additions & 0 deletions electrical/intro.md
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 9 additions & 0 deletions electrical/presentations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
******************
Presentations
******************

+--------------------------------------+-----------------+-----------------------------------------------------------------------------+
| Title | Author | Description |
+======================================+=================+=============================================================================+
| Robotics Interest Meeting 8_28_2023 | Rais Nurhidajat | Overview of robotics club and interest meeting information. |
+--------------------------------------+-----------------+-----------------------------------------------------------------------------+
5 changes: 5 additions & 0 deletions electrical/resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
Resources
******************

To be updated.
5 changes: 5 additions & 0 deletions electrical/system-design-review
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
System Design Review
******************

Add paragraphs here:
34 changes: 33 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -121,3 +145,11 @@
lidar/launchlocalization
lidar/parameters
lidar/localizationtheory


.. toctree::
:caption: Website RST Guide
:maxdepth: 3
:hidden:

rst/how-to-use-rst
9 changes: 9 additions & 0 deletions programming/cad.rst
Original file line number Diff line number Diff line change
@@ -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. |
+------------------------+-----------------+------------------------+-----------------------------------------------------------------+
5 changes: 5 additions & 0 deletions programming/design-spec.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
Design Specs
******************

To be updated...
22 changes: 22 additions & 0 deletions programming/intro.md
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 9 additions & 0 deletions programming/presentations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
******************
Presentations
******************

+--------------------------------------+-----------------+-----------------------------------------------------------------------------+
| Title | Author | Description |
+======================================+=================+=============================================================================+
| Robotics Interest Meeting 8_28_2023 | Rais Nurhidajat | Overview of robotics club and interest meeting information. |
+--------------------------------------+-----------------+-----------------------------------------------------------------------------+
5 changes: 5 additions & 0 deletions programming/resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
Resources
******************

To be updated.
5 changes: 5 additions & 0 deletions programming/system-design-review
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
******************
System Design Review
******************

Add paragraphs here:
165 changes: 165 additions & 0 deletions rst/how-to-use-rst.rst
Original file line number Diff line number Diff line change
@@ -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 |
+--------------+------------------------------------------------------------+----------------------------------------------+




Binary file added rst/scratch_cat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading