Skip to content

Commit 76fd7fa

Browse files
merged doc guides to one page, fixed links, applied recommended styleguide
1 parent efc333b commit 76fd7fa

File tree

5 files changed

+189
-220
lines changed

5 files changed

+189
-220
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ To get started, simply follow these steps
4747
4. Make **small and frequent** commits that include tests which could be a unity scene showing usage of your feature.
4848
5. Make sure that all the tests continue to pass.
4949
6. Follow the [Coding Guidelines](CodingGuidelines.md).
50-
7. Ensure the code and feature(s) are documented as described in the [Documentation Guidelines](DocumentationGuide.md).
50+
7. Ensure the code and feature(s) are documented as described in the [Documentation Guidelines](Documentation/DocumentationGuide.md).
5151
8. Ensure the code works as intended on all [platforms](#supported-platforms).
5252
- For Windows UWP projects, your code must be [WACK compliant](https://developer.microsoft.com/en-us/windows/develop/app-certification-kit). To do this, generate a Visual Studio solution, right click on project; Store -> Create App Packages. Follow the prompts and run WACK tests. Make sure they all succeed.
5353
9. Update the [documentation](#contributing) with additional information as needed.

Documentation/DevDocGuide.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Developer Documentation Guide
1+
# Developer portal generation guide
22

33
MRTK uses [docfx](https://dotnet.github.io/docfx/index.html) to generate html documentation out of triple slash comments in code and .md files in the MRTK repository. Docfx documentation generation is automatically triggered by CI (soon) on completed PRs in the mrtk_development branch.
44
The current state of the developer documentation can be found on the [MRTK github.io page](https://microsoft.github.io/MixedRealityToolkit-Unity/)
@@ -129,6 +129,7 @@ The versioning system can also be used for showing doc versions from other dev b
129129
* External crefs - As long as there's no xref service available (and listed in the docfx build file) crefs to external libraries won't work. If you still want to link to a specific external symbol that doesn't have xref service but an online api documentation you can use a href instead. Example: linking to EditorPrefs of Unity: <see href="https://docs.unity3d.com/ScriptReference/EditorPrefs.html">EditorPrefs</see>
130130

131131
## See also
132-
* [DocFX](https://dotnet.github.io/docfx/index.html)
132+
* [MRTK documentation guide](DocumentationGuide.md)
133133
* [MRTK developer documentation on github.io](https://microsoft.github.io/MixedRealityToolkit-Unity/)
134+
* [DocFX](https://dotnet.github.io/docfx/index.html)
134135

Documentation/DocContribution.md

Lines changed: 0 additions & 162 deletions
This file was deleted.

0 commit comments

Comments
 (0)