ACE3/docs/wiki/development/documentation-guidelines-and-tips.md

layout	title	group	parent	order
wiki	Documentation guidelines and tips	development	wiki	19

Documentation guidelines

Example entry

---
layout: wiki
title: Mission Modules
group: feature
parent: wiki
---

## 1. Overview

### 1.1 Sub-feature 1
Short description of sub-feature 1.

### 1.2 Sub-feature 2
Short description of sub-feature 2.

## 2. Usage

### 2.1 thing n°1

- Step 1.
- Step 2.
- Step 3.

### 2.2 thing n°2

- Step 1.
- Step 2.
- Step 3.

## 3. Dependencies

`ace_something`

## 4. Guides

Guidelines

• A line between each entry like above.
  • This is especially necessary for the kramdown markup syntax. Kramdown needs a line break between each block level element (paragraphs, lists, codeblocks, etc ...)
• Use ACE3 instead of ACE 3.
• Remove each entry that is not used.
• Don't forget to say what you're going to work on in #documentation in slack or this topic
• Keybinds in <kbd>keyboard tags</kbd>
• Keywords in `backticks`
• Capitals at the start of a sentence and .at the end.
• Verify everything in game

Tips

• Use http://dillinger.io/ to keep your sanity
• Markdown cheat sheet