Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add wiki ACEX sections and merge Mission Makers and Framework sections (#4307)

Browse Source 
* Update documentation guidelines

* Add version info part 1

* Add version info part 2

* Add removed in version to frontmatter and tag testmissions as removed

* Add version info part 3

* Seaparate ACE3 and ACEX Features/Framework menus, Add ACEX Headless documentation

* Add ACEX support to extract_dependencies.py

* Merge useful-functions into frameworks

* Move class-names to main menu

* Prettify class-names table titles

* Fix table of contents on documentation guidelines and tips

* Merge mission-tools into frameworks

* Merge modules into frameworks

* Rename to Frameworks (plural)

* Fix capitalization in class-names

* Improve wiki menu positioning

* Add 'mod' to documentation guidelines

* Update frameworks sections description for new content

* Update wiki menu descriptions

* Fix class-names 4 digit versions

* More places for descriptions

* Include documentation in PRs if applicable note

* Add short ACE3 and ACEX description page, outlining the difference
This commit is contained in:
jonpas
2016-09-08 21:19:07 +02:00
committed by Glowbal
parent 7ca4fff674
commit 65df821e2b
38 changed files with 882 additions and 1102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/wiki/development/documentation-guidelines-and-tips.md
View File

@ -6,7 +6,7 @@ parent: wiki
order: 19
---
# 1. Documentation Guidelines
## 1. Documentation 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 ...)
@ -18,12 +18,12 @@ order: 19
- Capitals at the start of a sentence and `.`at the end.
- Verify everything in game
## 1.1 Tips
### 1.1 Tips
- Use [http://dillinger.io/](http://dillinger.io/) to keep your sanity
- [Markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
## 1.2 Feature Template
### 1.2 Feature Template
```
---
@ -33,6 +33,7 @@ description: Description of the feature.
group: feature
category: interaction
parent: wiki
mod: ace
version:
major: 3
minor: 0
@ -72,7 +73,7 @@ Short description of sub-feature 2.
Information about other guides and pages about this feature.
```
## 1.3 Framework Template
### 1.3 Framework Template
```
---
@ -81,6 +82,7 @@ title: Component Framework
description: Description of the framework.
group: framework
parent: wiki
mod: ace
version:
major: 3
minor: 0