DOCUMENTATION.md

Documentation Styleguide

These are the guidelines for writing documentation for an example.

Titles

• Each document must have a single #-level title at the top.
• The phrase "UI" must be capatalised.
• Sub-chapters need to increase the number of # in the title according to their nesting depth.
• All words in the page's title must be capitalised, except for conjunctions like "of" and "and".

Notes

• Please use relative links when possible.

Document flow

Completed examples

For completed examples you should use this as a template:

# Examples Project Name
![Example demo image](LINK TO IMAGE)

### Description
...

### Supported aspect ratios
* 5:4 ❌
* 4:3 ❌
* 3:2 ❌
* 16:10 ✅
* 16:9 ✅

### Supported Platforms
* Editor ❌
* Standalone ✅
* UWP ❓

**Mobile**
iOS ❓
Android ✅

**Console**
* Xbox One ❓
* PS4 ❓

### Parameters
...

In-Progress examples

Examples which have yet to be finished are permitted to omit paramaters, but the demo image, supported aspect ratios and supported platforms must still be in the README. Use this as a template.

# Examples Project Name
![Example demo image](LINK TO IMAGE)

### Description
...

#### Included: 
...

#### Todo:
...

### Supported aspect ratios
...

### Supported Platforms
...

### Parameters

Parameters

In the parameters section, you should list all fields/properties that are configurable (Including private fields exposed with [Serialize]). An exmaple of a field to show would be FOV for a camera.

• Make sure you add a short description.
• Sub classes should be in bold.
• Fields/properties should be indented.
• Sub classes fields/properties should be double indented.

See HERE for a good example of documentation.