CONTRIBUTING.md

Contributing documentation:

If you see something wrong or missing from the documentation and want to fix it yourself you may modify the GitHub markdown files in the /docs folder and put in a pull request. Documentation is written in markdown

Kitbashery uses the Jekyll theme: Just the Docs and uses the following navigation structure:

Asset Name 
  Classes
    Script.cs
  Structs
    MyStruct
  Enumerations
    MyEnum

Navigation structure is defined by the theme using YAML front matter you can read about the theme's navigation system here.

Page layout is:

Page navigation YAML Front Matter...

Class/Struct/Enum Name

Inherits from:

Link to class (if applicable)

Description:

Your description

Usage Examples:

public void Spawn()
{
    GameObject go = ObjectPools.Instance.GetPooledObject("MyPrefabName");
    go.transform.position = Vector3.Zero;
    //Do other things to the GameObject...
    go.SetActive(true);
}

Usage Notes:

Any remarks on how to use the file.

Public Properties:

| Type        | Name | Description         | Default Value |
|:-------------|:----|:--------------------|:--------------|
|  `type` | name | description | `default value` |

Public Methods:

| Name | Summary      | Parameters | Returns |
|:----|:--------------|:-----------|:--------|
| MethodName | MethodSummary... | Type paramName "param summary", Type, paramName2 "param summary" | `Void` "returns summary" |

Structs:

[Serializable] Struct Name

Struct Public Properties:

...

Enumerations

Enumeration Name

{ enumValue, enumValue2 }