Permalink
Fetching contributors…
Cannot retrieve contributors at this time
66 lines (44 sloc) 1.59 KB
title
Documentation Guidelines

Overview

This documentation is built using Jekyll Documentation Theme (commit), all the theme documentation and tutorials are appliccable to ACRE2's documentation, with few changes:

  • Added nicer keyboard tags styling
  • Merged news pages into main part
  • Removed tooltips functionality
  • Removed multi-project functionality

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 ACRE2 instead of ACRE 2.
  • Remove each entry that is not used.
  • Don't forget to say what you're going to work on on Slack.
  • Keybinds in <kbd>keyboard tags</kbd> (eg. ⇧ Shift+G).
  • Keywords in backticks.
  • Capitals at the start of a sentence and . at the end.
  • Verify everything in-game-

Tips

Template

---
title: Component
---

## Overview

### Sub-feature 1

Short description of sub-feature 1.

### Sub-feature 2

Short description of sub-feature 2.

## Usage

### Thing n°1

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

### Thing n°2

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

## Guides

Information about other guides and pages about this feature.