Merge pull request #3811 from davidkline-ms/docs_diags

Getting started and configuring documentation for the diagnostics system

Author: David Kline

Documentation/Diagnostics/ConfiguringDiagnostics.md

@@ -0,0 +1,49 @@
+# Configuring the Diagnostics System
+
+The diagnostics system profile provides options for configuring:
+- [General Settings](#general-settings)
+- [Profiler Settings](#profiler-settings)
+
+## General Settings
+
+![Diagnostics General Settings](../../External/ReadMeImages/Diagnostics/DiagnosticsGeneralSettings.png)
+
+### Show Diagnostics
+
+Indicates whether or not the diagnostics system is to display the configured diagnostic options.
+
+> When disabled, all configured diagnostic options will be hidden.
+
+## Profiler Settings
+
+![Diagnostics Profiler Settings](../../External/ReadMeImages/Diagnostics/DiagnosticsProfilerSettings.png)
+
+### Show Profiler
+
+Indicates whether or not the Visual Profiler is to be displayed.
+
+### Frame Sample Rate
+
+The amount of time, in seconds to collect frames for frame rate calculation. The range is 0 to 5 seconds.
+
+### Window Anchor
+
+To what portion of the view port should the profiler window be anchored. The default value is Lower Center.
+
+### Window Offset
+
+The offset, from the center of the view port, to place the Visual Profiler. The offset will be in the direction
+of the [Window Anchor](#window-anchor).
+
+### Window Scale
+
+Size multiplier applied to the profiler window. For example, setting the value to 2 will double the window size.
+
+### Window Follow Speed
+
+The speed at which to move the profiler window to maintain visibility within the view port.
+
+## See Also
+
+- [Diagnostics System](DiagnosticsSystemGettingStarted.md)
+- [Using the Visual Profiler](../TODO.md)

Documentation/Diagnostics/DiagnosticsSystemGettingStarted.md

@@ -0,0 +1,63 @@
+# Diagnostic System
+
+The Mixed Reality Toolkit Diagnostics System provides diagnostic tools that run within the 
+application to enable analysis of application issues. 
+
+The first release of the diagnostics system contains the Visual Profiler to allow for analyzing 
+performance issues while using the application. 
+
+## Getting Started
+
+> It is **_highly_** recommended that the diagnostics system be enabled throughout the entire product 
+development cycle and disabled as the last change prior to building and releasing the final version.
+
+1. [Enable](#enable-diagnostics) the diagnostic system
+2. [Configure](#configure-diagnostic-options) diagnostic options
+3. [Build and deploy](#build-and-deploy)
+
+### Enable Diagnostics
+
+The diagnostics system is managed by the MixedRealityToolkit object (or another 
+[service registrar](xref:Microsoft.MixedReality.Toolkit.IMixedRealityServiceRegistrar) component). 
+
+> The following steps presume use of the MixedRealityToolkit object. Steps required for other service registrars may be different.
+
+1. Select the MixedRealityToolkit object in the scene hierarchy.
+
+![MRTK Configured Scene Hierarchy](../../External/ReadMeImages/MRTK_ConfiguredHierarchy.png)
+
+2. Navigate the Inspector panel to the Diagnostics System section and check Enable
+
+![Enable the Diagnostics System](../../External/ReadMeImages/Diagnostics/MRTKConfig_Diagnostics.png)
+
+3. Select the Diagnostics System implementation
+
+![Select the Diagnostics System Implementation](../../External/ReadMeImages/Diagnostics/DiagnosticsSelectSystemType.png)
+
+> Users of the default profile (DefaultMixedRealityToolkitConfigurationProfile) will have the 
+diagnostics system pre-configured to use the MixedRealityDiagnosticsSystem object.
+
+### Configure Diagnostic Options
+
+The diagnostics system uses a configuration profile to specify which components are to be displayed 
+and to configure their settings. Please see [Configuring the Diagnostics System](ConfiguringDiagnostics.md) 
+for more information pertaining to the available component settings. 
+
+![Diagnostics Options](../../External/ReadMeImages/Diagnostics/DiagnosticsProfile.png) 
+
+### Build and Deploy
+
+Once the diagnostic system is configured with the desired options, the project can be built 
+and deployed to the target platform.
+
+> While it is possible to use Unity's Play Mode while developing applications without requiring the build 
+and deploy steps, it is important to evaluate the diagnostics system results using a compiled application 
+running on the target hardware and platform. Performance diagnostics, such as the Visual Profiler, may not 
+accurately reflect actual application performance when run from within the editor.
+
+## See Also
+
+- [Diagnostics API documentation](xref:Microsoft.MixedReality.Toolkit.Diagnostics)
+- [Configuring the Diagnostics System](ConfiguringDiagnostics.md)
+- [Using the Visual Profiler](../TODO.md)
+

Documentation/Diagnostics/UsingVisualProfiler.md

@@ -0,0 +1,8 @@
+# Using the Visual Profiler
+
+<< >>
+
+## See Also
+
+- [Diagnostics System](DiagnosticsSystemGettingStarted.md)
+- [Configuring the Diagnostics System](ConfiguringDiagnostics.md)

Documentation/toc.yml

@@ -65,11 +65,15 @@
       href: SpatialAwareness/SpatialAwarenessGettingStarted.md
       items:
       - name: Configuring the Spatial Awareness Mesh Observer
-        href: SpatialAwareness/ConfiguringSpatialAwarenessMeshObserver.md
     - name: In-Editor Input Simulation
       href: TODO.md
-    - name: Performance Diagnostic Tool
-      href: TODO.md
+    - name: Diagnostics System
+      href: Diagnostics/DiagnosticsSystemGettingStarted.md
+      items:
+      - name: Configuring the Diagnostics System
+        href: Diagnostics/ConfiguringDiagnostics.md
+      - name: Using the Visual Profiler
+        href: TODO.md
   - name: Other Features
     href: TODO.md
     items: