Merge pull request #36 from chanmosq/component-reference-template

Create component-reference.md

doc-templates/component-reference.md

@@ -0,0 +1,125 @@
+---
+linkTitle: Component Name
+title: [Component Name] Component
+description: The [component name], which does [function], is provided by the [Gem name] in Open 3D Engine (O3DE). # Example
+weight: 200 # (Optional) Example
+toc: true
+---
+
+<!-- This is a template to create a component reference document. As you write this document, please refer to the writing guidelines: https://www.o3de.org/docs/contributing/to-docs/templates/component-reference-doc/-->
+
+<!-- Introduction - Describe the component and what it does. -->
+
+
+## Provider
+
+[Gem's name](/docs/user-guide/gems/reference/<path-to-gem-docs>)
+
+
+## Dependencies
+
+<!-- (Optional) List the component's dependencies -->
+
+
+## Use cases
+
+<!-- (Optional) Write the use cases in which a user may want to use this component. -->
+
+
+## Limitations
+
+<!-- (Optional) Write the limitations of this component. Don't include any "future work". -->
+
+
+## Properties
+
+<!-- This example is for a simple set of properties. 
+If you use this section, then delete the other Properties section. -->
+
+![[component name] interface](/images/<path-to-images>)
+
+| Property | Description | Value | Default |
+| - | - | - | - |
+|   |   |   |   |
+|   |   |   |   |
+|   |   |   |   |
+
+
+## Properties
+
+<!-- This example is for a complex set of properties. 
+If you use this section, then delete the other Properties section. -->
+
+![[component name] interface](/images/<path-to-image>)
+
+
+### Base properties
+
+| Property | Description | Value | Default |
+| - | - | - | - |
+|   |   |   |   |
+|   |   |   |   |
+|   |   |   |   |
+
+### [Property group] properties
+
+![[property group] interface](/images/<path-to-image>)
+
+| Property | Description | Value | Default |
+| - | - | - | - |
+|   |   |   |   |
+|   |   |   |   |
+|   |   |   |   |
+
+### [Configuration] properties
+
+{{< tabs >}} 
+{{% tab name="[configuration 1] properties" %}}
+
+![[configuration 1] interface](/images/<path-to-image>)
+
+| Property | Description | Value | Default |
+| - | - | - | - |
+|   |   |   |   |
+|   |   |   |   |
+|   |   |   |   |
+
+{{% /tab %}}
+{{% tab name="[configuration 2] properties" %}}  
+
+![[configuration 2] interface](/images/<path-to-image>)
+
+| Property | Description | Value | Default |
+| - | - | - | - |
+|   |   |   |   |
+|   |   |   |   |
+|   |   |   |   |
+
+{{% /tab %}}
+{{< /tabs >}}
+
+
+## [Component feature]
+
+<!-- (Optional) Explain specific features of your component. Repeat this section for each additional topic, as needed. -->
+
+
+## [EBus interface name]RequestBus
+
+<!-- (Optional) Example: "Use the following request functions with the <Request EBus name> EBus interface to communicate with <component name> in your game." -->
+
+| Method Name | Description | Parameter | Return | Scriptable |
+| - | - | - | - | - |
+|   |   |   |   |   |
+|   |   |   |   |   |
+|   |   |   |   |   |
+
+## [EBus interface name]NotificationBus
+
+<!-- (Optional) Example: "Use the following notification functions with the <Notification EBus name> EBus interface to communicate with <component name> in your game." -->
+
+| Method Name | Description | Parameter | Return | Scriptable |
+| - | - | - | - | - |
+|   |   |   |   |   |
+|   |   |   |   |   |
+|   |   |   |   |   |