The Terasology Foundation

Review wiki pages

Every open source project needs documentation - tons and tons of it. However, with time the documentation might become obsolete, and even the documentation that isn't obsolete can always use some love.

This task requires the students to go through the wiki, fixing broken links or better expressing a particular section.

Acceptance Criteria

  • Make a new page with the "gciDraft" suffix, and make all the relevant changes to that page.
  • Screenshots highlighting the changes made to the page.

Where to start

  • Check out the wiki's for modules by going to a repo on this list and then going to the wiki tab
    • Not all modules have wikis, if the module you open doesn't have one then just pick a different module.
      • Keep track of all modules without a Wiki so we can discuss if it actually needs it.
  • The main Terasology wiki
  • The main Destination Sol wiki

Note: This is a multi-instance task - other students can pick it too and might end up fixing the same reports. Take a look at pending PRs in the relevant repo before submitting yours; if another student has already fixed some issues in the same classes as you, you may need to change what you're fixing or wait till the earlier work is merged, then adjust what you're adding.

Task tags

  • documentation
  • tutorial
  • writing

Students who completed this task

HannahG

Task type

  • chrome_reader_mode Documentation / Training
close

2019