Wiki Best Practices - MDHSRobotics/TeamWiki GitHub Wiki
Home / Tutorials / [How to Wiki](How to Wiki)
In order to make the Team Wiki easy to use and navigate, the following practices shall be observed:
[<Page Title>](<Page File Name or URL>)
where
-
<Page Title>
is replaced by the title you want to give your page in the link -
<Page File Name or URL>
is replaced by the file name of the page. When creating a page on the wiki, it is OK to use the same value as the title. When linking to a page on the internet, use the full URL -
example, this page:
`[Wiki Best Practices](Wiki-Best-Practices)`
- example, 2016 FRC Control System:
`[2016 FRC Control System](https://wpilib.screenstepslive.com/s/4485)`
- Put Navigation links at the top of the page. Navigation links should start with a link to the home page of the wiki and have a link through all of the parents of the current page. The last link in the sequence should be the immediate parent of the page being edited.
- example, this page:
[Home](Home) / [Tutorials](Tutorials) / [How to Wiki](How to Wiki)
- example, this page:
- Put the title after the navigation link and use the
#
symbol to emphasize it as the page title.- example, this page:
# Wiki Best Practices
- example, this page:
Although GIT supports several wiki syntax, to make it easier to collaborate, we will standardize on the default which is markdown.
- No broken links
- Navigation works as expected
- Markdown works as expected