Contributing#

Helping out with the project!

Documentation#

There are a couple of ways to contribute to this project:

  • Via the web
    • Recommended for quick changes and those without developer/programming experience
  • Via local source
    • Recommended for those with developer/programming experience.

Via the web#

Recommended for quick changes and those without developer/programming experience.

Editing Pages#

On each page there is an option to edit the page. Any changes you make through this option will be submitted and become live once they are approved.

The edit icon looks like this:

Alternatively you could create a pull request and clone the repository

New Pages#

You can help the project by making new pages. Any pages you make will become live once they are approved.

Click here to create a new page

Please use the New Page Template

Click here to see tips on creating markdown documents

Warning

Make sure all documentation files end in .md

Tip

You can add to a certain tab by appending /tab_name/ to the file name

Tip

Visit Admonitions (call-out) references for a list off call-outs like this one.

Via local source#

Recommended for those with developer/programming experience.

Prerequisites#

  1. Install GitHub Desktop (Beginner) or Install Git (Expert)
  2. Install Python
  3. Install pip requirements
    1. Run one of the following commands. Try each one in order until successful.
      • pip install -r requirements.txt
      • python -m pip install -r requirements.txt
      • py -m pip install -r requirements.txt

Creating local edits#

  1. Visit https://github.com/FRCTeam3255/FRC-Mechanical-Guide/tree/main/ and fork the repository.
  2. Clone your the newly created fork to your machine
  3. Run the command mkdocs serve to open up a live local version of the project in your browser
  4. If mkdocs serve does not work on its own, try each one in order until successful:
    • python -m mkdocs serve
    • py -m mkdocs serve
  5. Make your changes or additions in the docs directory.
  6. Please maintain the organizational folder structure.
  7. If added a new page, add the relative url to the mkdocs.yml file in the # Navigation (nav:) section.
  8. For new pages please use the New Page Template
  9. Click here to see tips on creating markdown documents

Pushing your local edits to the web#

  1. Commit your changes
  2. Push your changes to GitHub
  3. Back on the webpage for your fork of the project select Pull Request
  4. Create a new pull request
  5. Wait for the pull request to be approved.

New Page Template#

Please copy this code as a template to create your new page

```markdown

Page title#

Subtitle

Image Title

Overview#

This section will help you learn to BLANK.

See table of contents for a breakdown of this section.

Section One#

  • Some info
  • Some other into
    • Some sub info

Section One Subsection#

Section Two#

  • Info
  • Info 2

Tip

This is a tip.

```