mirror of
https://github.com/acemod/ACE3.git
synced 2024-08-30 18:23:18 +00:00
836cd9d833
- Fixed typos in laser/readme - Documentation guidelines updated - ACE3 mentions updated in - - ai - Updated doc - - fcs - - hearing - -hitreaction - - interaction - - interact_menu - - inventory - - javelin - - laser - - laserpointer - - laser_selfdesignate - - logistics_uavbattery - - logistics_wirecutter - - magazinerepack - - main - - map - - maptools - - markers
1.1 KiB
1.1 KiB
| 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.
- Use
ACE3instead ofACE 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] (https://github.com/acemod/ACE3/issues/1166)
- Keybinds in
<kbd>thoses thingies</kbd> - Keywords in
`thoses thingies` - Capitals at the start of a sentence and
.at the end. - VERIFY EVERYTHING IN GAME, ALL THE THINGS
Tips
- Use http://dillinger.io/ to keep your sanity
- [Markdown cheat sheet] (https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)