Editing the Wiki

Syntax

Wiki Conventions

Project Versions

The wiki will always reference the most up-to-date version of the project. Information related to older versions should (1) either explicitly mention this up front or (2) create and older page and link to it from the current page.

Links and Uploads

Design Files

Design files are subject to change between versions. As such, do not upload design files to the wiki. Rather link them to the file in the master branch of the project repository.

Exception: aesthetic-only or placeholder images that clearly point to the most up-to-date version are OK.

PDFs hosted on Github

Links to PDFs hosted on Github will redirect to a github rendering of the PDF as a PNG image on Github's website. This isn't really ideal. As a workaround, we can modify the link to get Google's PDF doc viewer to render it cleanly in a format that can be readily printed. To do this, prefix the github URL with the following:

   https://docs.google.com/viewer?url=

Then, in the url, change blob to raw. When the page is saved, the result should be a link that, when clicked presents a preview of the PDF as if it were ready to be printed.