Tutorial: Robolab Documentation

Overview:

This page documents how to document on wikis throughout the Olin Robotics Lab. The following formatting is used by Connor Novak, the current Documentation Overlord, and is an effective and standardized way of conveying information.

Process:

1. Create Page
   Create a new page using the green "New Page" button in the upper right of every Wiki page.
2. Choose Title
   Title your page with the appropriate sub-heading and piece of information (i.e. Documentation: Intro to Documentation).
3. Write Documentation Detail the steps you took such that someone with no prior experience can follow them (See the toolbar when writing for how to properly use Markdown). Check out the reference links for some useful Markdown basics. (reference) (reference)
4. Add Links If you found any online documents helpful, link them using the link button in the Markdown toolbar. If you referenced any other pages of this or other Wikis, include a link to the page by copying and linking the URL of the page. If you want to link to a heading on the page, click the link icon that shows up when you mouse over the heading on the respective page and copy the resulting URL.
5. Add Images
   If you have taken or could take images that are useful for understanding your work, follow these steps.

• 1a. Clone the respective repository, place image file in images folder, commit, and push.
• 1b. Navigate to the images folder of the repository and use the "Upload Files" button to upload your image file.
• 2a. Use the image icon in the toolbar, or use this syntax to put the image into your markdown file: ![minion image caption]https://github.com/olinrobotics/olinrobotics.github.io/blob/master/images/minion.png)
  
• 2b. To resize the image, instead use this syntax and replace '200' with the desired image width. <img src="https://github.com/olinrobotics/olinrobotics.github.io/blob/master/images/minion.png" width="200">

6. Signature
   After completing your documentation, include a line dictating when you modified the page. If one with your name already exists, modify it. Otherwise, create a new line. (ex. *Last edited by Connor Novak on 4/25/17.*)
7. Finishing Up
   Commit changes and save the page. If you would like, submit a quick message stating what you documented so that if later readers have questions about a piece of documentation, they know who added it and when.

Last edited by Connor Novak on 09/02/17. Last edited by Christina Segar on 07/12/17.