appendix e wiki guidelines

Wiki Guidelines Contents

• General
• Page Standards
• Making and naming folders
• Making and naming pages
• Making and naming files
• Media

Wiki Guidelines

General

This is developer documentation. Guidelines for how to edit our wiki.

Our wiki uses markdown. Familiarize yourself with markdown here at markdownguide.org.

But for quick reference us the Markdown Cheat Sheet

• Edit the wiki via a text editor and version control.
• we recommend VS code and github desktop
• it has preview
• use good commit practices
• Don't edit the wiki via the browser. (only in emergency)

Page Standards

• Each page should have 2 H1s
  • a "[Page Title] Contents"
  • a "[Page Title]"
• "[Page Title] Contents" is the first thing on each page
• after "[Page Title] Contents", then place the "[Page Title]", then list out the content of the page
• Specific page subsections start with H2s to divide up the page into sections
  • use next level headings as needed
• the "[Page Title] Contents" should contain and link to all the headings on the page (excluding the H1s)
  • Use this page as an example.

Table of Contents Guidelines

• only "H2"s and "H3"s are allowed in the "[Page Title] Contents"
• if a H4 is on a page we do not display it in the "[Page Title] Contents"
• if you deem necessary, then when your H3 starts you can put a sub contents list of all our H4s for ease of sub navigation
  • use an ordered list if you do this.
  • an example of this can be found on the "Color Palette" section of the aesthetic design page.
  • another example of this can be found on the "offense items" section of the gameplay design page. (in this case the example is a H4 and H5s)

Making and naming folders

• Use lowercase
• use "-" for spaces

Examples:

• "loreum"
• "loreum-ipsum"
• "gameplay-design"
• "images/gameplay-design"

Making and naming pages

• Use lowercase
• use "-" for spaces
• save and use markdown
• file extension for markdown is ".md"
• if you make a new page, then please add it to "_Sidebar.md" and "_Footer.md"

Examples:

• "home.md"
• "appendix-a-team-information.md"

Making and naming files

• Use lowercase
• use "_" for spaces
• file extension must have lowercase
  • example: "file.png" VS "file.PNG"

Examples:

• "nick_buonarota.png"

Media

For media, such as images, animated gifs, and videos

They should be stored in the "media" folder.