Skip to content

Commit 935f14d

Browse files
added documentation section for experimental features by @julenka
1 parent 1969f44 commit 935f14d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Documentation/Contributing/ExperimentalFeatures.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@ Adding a component menu:
5959
[AddComponentMenu("MRTK/Experimental/MyCommand")]
6060
```
6161

62+
## Documentation
63+
Follow these steps to add documentation for your experimental feature:
64+
65+
1. Any documentation for an experimental feature should go in a `README.md` file in the experimental folder. For example, [`MixedRealityToolkit.SDK/Experimental/ScrollingObjectCollection/README.md`](../../Assets/MixedRealityToolkit.SDK/Experimental/ScrollingObjectCollection/README.md).
66+
67+
1. Under *Feature Overviews* Add a link in the *Experimental* section at [`Documentation/toc.yml`](../toc.yml).
68+
6269
### Minimize impact to MRTK code
6370

6471
While your MRTK change might get your experiment to work, it could impact other people in ways you do not expect.

0 commit comments

Comments
 (0)