Tutorial: Documentation

Tutorial: How to Document Edwin

Overview

Documentation in Edwin occurs entirely in GitHub wiki, with pages for each project. Edwin also has a page on the OlinRobotics website, but this page is a general overview of the team that is independent from the wiki. Documentation on Edwin should be updated when:

• You start or update a project
• You discover a bug in Edwin, your project, or someone else's project
• You solve a bug in above

General Markdown Basics

Github Wiki pages are written in the Markdown language. The language is a format-based language, much like HTML. It's fairly easy to write, and most of the work involves looking up what you want to do and copying the formatting of the code that you find. Github has a nice bar with buttons for quite a few different functions that you can use. Additionally, RStudio has a general page for basic Markdown commands that is useful. To access the Markdown file for a given GitHub page, click the "Edit" button (next to the "New Page" button) on the right hand side of the website.