Wiki convention

Convention for Github's Wiki

In short, the convention is as follows:

1. filenames in lower case
2. dash for spaces
3. one unique name wiki-wide
4. document hierarchy mirrored by physical file placement.

Avoiding name clashes

The third item in the convention is due to the following. Github's Gollum engine doesn't distinguish files per it's location, which results in having only one logical name regardless of its location. For example, Wiki entry

research/paper-summaries/2010-10-29/01-paper-name.md

is the same as

research/paper-summaries/01-paper-name.md

Gollum translates whatever it finds first and assigns that to a corresponding wiki page.

Physical File structure

As a consequence of the above, Github doesn't identify the hierarchical relation between Wiki entries. In order to avoid confusion and keep documentation clean, the logical hierarchical structure of the Wiki should be mirrored on the filesystem. For example, the first level and highest level contains the home page and this (convention) entry. Also, pointers to subsections (research, development and manuals) which correspond to subfolders in the Wiki's root folder.