Wiki Style Guide

THIS DOCUMENT IS STILL BEING DEVELOPED.

Based on discussion with @AdriVanHoudt, @gyaresu, and @zoe-1,
so far these are the basic guidelines for the wiki. Please make suggestions here:
https://github.com/hueniverse/hueniversity/issues/105

Purpose of Wiki

The purpose of the wiki is to guide someone to complete hueniversity assignments
and review important concepts of each assignment.

Style Recommendations

• Use markup lists, do not put numbers in lists. For example, see @AdriVanHoudt example here: https://github.com/hueniverse/hueniversity/wiki/3.1-Start to have clear step by step approach.

• Naming of Assignments
  Assignment number then sub-number then assignment-name format.
  For example, if we use this format the menu would look like the below which would allow readers to easily navigate.
  
  

      4   Assignment
      4.1 sub-title
      4.2 sub-title 
      4.3 ......
      .....
  

• Guide Structure

  • Introduction
    Give an overview of the assignment's main learning objectives
  • Git setup
    Explain to the reader how to find the correct project state in the
    git repo. What commit should they checkout?
    
  • Body
    A step by step explanation of how to complete the assignment.
    Assignment3 is an example of how to do this in step by step fashion.
    

• Closure
  Review the objectives of the assignment.
  Make suggestions to other resources for further study.