MovingBlocks

Create a wiki template to be used in modules

Every GitHub repository comes equipped with a section for hosting documentation, called a wiki. It usually contains documentation and tutorials, side-by-side with the code, can be helpful for both developers and users. To simplify navigation between modules and finding relevant information, we would like to unify the appearance of module wikis.

Your tasks is to provide a wiki template which can be used in modules. The wiki should be easy to navigate - the front page should contain clear directions to sub-categories like "Getting Started", "User Manual", or "Developer Guide". You can either create a clean template from scratch or rework an existing module wiki to adhere the target criteria.

Definition of 'Done'

An (empty) GitHub repository is provided with a template GitHub wiki to be used in modules, containing the following:

  • A "starting page" allowing to navigate to different categories (e.g., user help, development)
  • A concept for a navigation header (has to be provided manually in GitHub wikis)
  • A footer with helpful links (e.g., to the main project, the launcher, ...)

Where to start?

Task tags

  • wiki
  • markdown
  • github
  • documentation

Students who completed this task

Benjamin Amos

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
close

2016