Merge pull request #7247 from keveleigh/spell-check

Spellcheck and formatting in 2.3 docs

Author: keveleigh

Documentation/Contributing/ExperimentalFeatures.md

@@ -60,9 +60,10 @@ Adding a component menu:
 ```
 
 ## Documentation
+
 Follow these steps to add documentation for your experimental feature:
 
-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). 
+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).
 
 1. Under *Feature Overviews* Add a link in the *Experimental* section at [`Documentation/toc.yml`](../toc.yml).
 

Documentation/Contributing/Roadmap.md

@@ -14,7 +14,6 @@ This document outlines the roadmap of the Mixed Reality Toolkit.
 
 Releases are centered around themes (ex: large feature areas) and are scheduled to occur approximately every 8 weeks.
 
-
 Release details, including backlog items, can be found on the [GitHub milestone pages](https://github.com/Microsoft/MixedRealityToolkit-Unity/milestones). The complete set of open issues can also be found on [GitHub](https://github.com/microsoft/MixedRealityToolkit-Unity/issues).
 
 ## Mixed Reality Toolkit (MRTK) roadmap
@@ -51,7 +50,7 @@ Quality and stability are the top priority for this and all Microsoft Mixed Real
 **User Experience**
 
 - Bug fixes
-- Hololens Shell parity
+- HoloLens Shell parity
 - Graduating experimental features
 - Tests to ensure features do not regress
 

Documentation/CrossPlatform/UsingARFoundation.md

@@ -4,34 +4,32 @@
 
 1. Download and import the **Microsoft.MixedReality.Toolkit.Providers.UnityAR** package, from [GitHub](https://github.com/microsoft/MixedRealityToolkit-Unity/releases/tag/v2.2.0) or [NuGet](../MRTKNuGetPackage.md)
 
-> [!NOTE]
-> After you import the the UnityAR package, you will see the following error: 
-> *Assembly has reference to non-existent assembly 'Unity.XR.ARFoundation' (Assets/MixedRealityToolkit.Staging/UnityAR/Microsoft.MixedReality.Toolkit.Providers.UnityAR.asmdef)*
-". To resolve, install the correct version of ARFoundation listed below.
+    > [!NOTE]
+    > After you import the the UnityAR package, you will see the following error:
+    > *Assembly has reference to non-existent assembly 'Unity.XR.ARFoundation' (Assets/MixedRealityToolkit.Staging/UnityAR/Microsoft.MixedReality.Toolkit.Providers.UnityAR.asmdef)*
+    ". To resolve, install the correct version of ARFoundation listed below.
 
+1. In the Unity Package Manager (UPM), install the following packages:
 
-2. In the Unity Package Manager (UPM), install the following packages:
-
-    **Unity 2018.4.x** 
+    **Unity 2018.4.x**
 
     | **Android** | **iOS** | Comments |
     | --- | --- | --- |
     | AR Foundation  <br/> Version: 1.5.0 - preview 6 | AR Foundation  <br/> Version: 1.5.0 - preview 6 | For Unity 2018.4, this package is included as a preview. To view package: Window > Package Manager > Advanced > Show Preview Packages|
     | ARCore XR Plugin <br/> Version: 2.1.2 | ARKit XR Plugin <br/> Version: 2.1.2 | |
 
-
     **Unity 2019.x**
 
-    | **Android** | **iOS** | 
+    | **Android** | **iOS** |
     | --- | --- |
     | AR Foundation  <br/> Version: 2.1.4 |  AR Foundation  <br/> Version: 2.1.4 |
     | ARCore XR Plugin <br/> Version: 2.1.2 | ARKit XR Plugin <br/> Version: 2.1.2 |
 
 1. If using Unity 2019.x, the assembly definition file for the Unity AR provider needs to be modified to have the **UnityEngine.SpatialTracking** reference added.
 
-    > [!Note]
+    > [!NOTE]
     > MRTK will automatically update the assembly definition based on the version of Unity in which the project has been loaded. This information is presented here for reference.
-    
+
     ![Unity AR assembly definition](../Images/CrossPlatform/UnityArAssemblyReferences.png)
 
 ## Enabling the Unity AR camera settings provider
@@ -68,24 +66,24 @@ The following steps presume use of the MixedRealityToolkit object. Steps require
 
 1. Make sure you have added the UnityAR Camera Settings Provider to your scene.
 
-2. Switch platform to either Android or iOS in the Unity Build Settings
+1. Switch platform to either Android or iOS in the Unity Build Settings
 
-When you switch the platform you should see the MRTK Project Configurator Window with settings for your chosen platform.  Click Apply to enable platform specific settings.
+    When you switch the platform you should see the MRTK Project Configurator Window with settings for your chosen platform.  Click Apply to enable platform specific settings.
 
-iOS Project Configurator Settings
+    iOS Project Configurator Settings
 
-![iOS Project Configurator](../Images/CameraSystem/MRTKProjectConfigurator.png)
+    ![iOS Project Configurator](../Images/CameraSystem/MRTKProjectConfigurator.png)
 
-3. There are no additional steps after switching the platform for Android. 
+1. There are no additional steps after switching the platform for Android.
 
-4. If the platform is iOS, Edit > Project Settings > Player > Other Settings, under the Optimization header, **uncheck** Strip Engine Code
+1. If the platform is iOS, Edit > Project Settings > Player > Other Settings, under the Optimization header, **uncheck** Strip Engine Code
 
-![iOS Settings](../Images/CameraSystem/UncheckStripEngineCodeiOS.png)
+    ![iOS Settings](../Images/CameraSystem/UncheckStripEngineCodeiOS.png)
 
-> [!NOTE]
-> Unchecking Strip Engine Code is the short term solution to an error in Xcode [#6646](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/6646).  We are working on a long term solution for MRTK 2.3.0.
+    > [!NOTE]
+    > Unchecking Strip Engine Code is the short term solution to an error in Xcode [#6646](https://github.com/microsoft/MixedRealityToolkit-Unity/issues/6646).  We are working on a long term solution.
 
-5. Build and run the scene
+1. Build and run the scene
 
 ## See also
 

Documentation/Extensions/HandPhysicsService/HandPhysicsServiceOverview.md

@@ -1,29 +1,39 @@
 # Hand physics extension service
+
 The hand physics service enables rigid body collision events and interactions with articulated hands.
 
 ## Enabling the extension
+
 To enable the extension, open your RegisteredServiceProvider profile. Click `Register a new Service Provider` to add a new configuration. In the component type field, select HandPhysicsService. In the configuration Profile field, select the default hand physics profile included with the extension.
 
 ## Profile options
+
 ### Hand physics layer
+
 Controls the layer the instantiated hand joints will go to.
 
 While the service defaults to the "default" layer (0), it is recommended to use a separate layer for hand physics objects. Otherwise there may be unwanted collisions and/or inaccurate raycasts.
 
 ### Finger tip kinematic body prefab
+
 Controls which prefab is instantiated on fingertips. In order for the service to work as expected, the prefab requires:
+
 - A rigidbody component, with isKinematic enabled
 - A collider
 - `JointKinematicBody` component
 
 ### Use palm kinematic body
+
 Controls whether the service will attempt to instantiate a prefab on the palm joint.
 
 ### Palm kinematic body prefab
+
 When `UsePalmKinematicBody` is enabled, this is the prefab it will instantiate. Just like `FingerTipKinematicBodyPrefab`, this prefab requires:
+
 - A rigidbody component, with isKinematic enabled
 - A collider
 - `JointKinematicBody` component
 
 ## How to use the service
-Once enabled, use any collider's `IsTrigger` property to receive collision events from all 10 digits (and palms if they're enabled).
+
+Once enabled, use any collider's `IsTrigger` property to receive collision events from all 10 digits (and palms if they're enabled).

Documentation/EyeTracking/EyeTracking_Positioning.md

@@ -3,8 +3,8 @@
 # Eye-supported target positioning in MRTK
 
 <!-- TODO: Add content -->
-_We're currently restructuring and improving the MRTK documentation. 
-This content will be updated soon! 
+_We're currently restructuring and improving the MRTK documentation.
+This content will be updated soon!
 If you have any questions regarding this section please post in our MRTK slack channel._
 
 ![MRTK](../Images/EyeTracking/mrtk_et_positioning_slider.png)

Documentation/Input/Pointers.md

@@ -103,20 +103,18 @@ The *[SpherePointer](xref:Microsoft.MixedReality.Toolkit.Input.SpherePointer)* u
 
 <img src="../../Documentation/Images/Pointers/MRTK_GrabPointer.jpg" width="400">
 
-
 Useful Sphere Pointer properties:
 
 - *Sphere Cast Radius*: The radius for the sphere used to query for grabbable objects.
 - *Grab Layer Masks* - A prioritized array of LayerMasks to determine which possible GameObjects the pointer can interact with and the order of interaction to attempt. Note that a GameObject must also have a `NearInteractionGrabbable` to interact with a SpherePointer.
-> [!NOTE]
-> The Spatial Awareness layer is disabled in the default GrabPointer prefab provided by MRTK. This is done to reduce performance impact of doing a sphere overlap query with the spatial mesh. You can enable this by modifying the GrabPointer prefab.
+    > [!NOTE]
+    > The Spatial Awareness layer is disabled in the default GrabPointer prefab provided by MRTK. This is done to reduce performance impact of doing a sphere overlap query with the spatial mesh. You can enable this by modifying the GrabPointer prefab.
 - *Ignore Colliders Not in FOV* - Whether to ignore colliders that may be near the pointer, but not actually in the visual FOV.
-This can prevent accidental grabs, and will allow hand rays to turn on when you may be near 
-a grabbable but cannot see it. The *Visual FOV* is defined via a cone instead of the the typical frustum for performance reasons. This cone is centered and oriented the same as the camera's frustum with a radius equal to half display height(or vertical FOV). 
+This can prevent accidental grabs, and will allow hand rays to turn on when you may be near
+a grabbable but cannot see it. The *Visual FOV* is defined via a cone instead of the the typical frustum for performance reasons. This cone is centered and oriented the same as the camera's frustum with a radius equal to half display height(or vertical FOV).
 
 <img src="../../Documentation/Images/Input/Pointers/SpherePointer_VisualFOV.png" width="200">
 
-
 #### Teleport pointers
 
 - [`TeleportPointer`](xref:Microsoft.MixedReality.Toolkit.Teleport.TeleportPointer) will raise a teleport request when action is taken (i.e the teleport button is pressed) in order to move the user.

Documentation/MRTK_PackageContents.md

@@ -19,7 +19,7 @@ The Microsoft.MixedRealityToolkit.Unity.Foundation package includes the core com
 | | [ObjectMeshObserver](SpatialAwareness/SpatialObjectMeshObserver.md) | Spatial awareness observer using a 3D model as the data. |
 | | OpenVR | Support for OpenVR devices. |
 | | WindowsMixedReality | Support for Windows Mixed Reality devices, including Microsoft HoloLens and immersive headsets. |
-| | WindowsVoiceInput | Support for speech and dicatation on Microsoft Windows platforms. |
+| | WindowsVoiceInput | Support for speech and dictation on Microsoft Windows platforms. |
 | MixedRealityToolkit.SDK | | |
 | | Experimental | Experimental features, including shaders, user interface controls and individual system managers. |
 | | Features | Functionality that builds upon the Foundation package. |
@@ -49,7 +49,6 @@ The optional Microsoft.MixedRealityToolkit.Unity.Extensions package includes add
 | | LostTrackingService | Service that simplifies handing of tracking loss on Microsoft HoloLens devices. |
 | | [SceneTransitionService](Extensions/SceneTransitionService/SceneTransitionServiceOverview.md) | Service that simplifies adding smooth scene transitions. |
 
-
 ## Tools
 
 The optional Microsoft.MixedRealityToolkit.Unity.Tools package includes helpful tools that enhance the mixed reality development experience using the Microsoft Mixed Reality Toolkit.

Documentation/Packaging/MRTK_Modularization.md

@@ -4,18 +4,18 @@ One of the great new features of Mixed Reality Toolkit v2 is improved componenti
 
 ## Minimized dependencies
 
-MRTK v2 was intentionally developed to be modular and to minimize dependencies between system services 
+MRTK v2 was intentionally developed to be modular and to minimize dependencies between system services
 (ex: spatial awareness).
 
 Due to the nature of some system services (ex: input and teleportation), a small number of dependencies exist.
 
-While it is expected that services will need one or more data provider components, there are no direct links 
+While it is expected that services will need one or more data provider components, there are no direct links
 between them. The same is true for SDK features (ex: User Interface components).
 
 ## Component communication
 
-To ensure that there are no direct links between components, MRTK v2 utilizes interfaces to communicate between 
-services, data providers and application code. These interfaces are defined in and all communication is routed 
+To ensure that there are no direct links between components, MRTK v2 utilizes interfaces to communicate between
+services, data providers and application code. These interfaces are defined in and all communication is routed
 through the Mixed Reality Toolkit core component.
 
 ![Using the spatial awareness system via interfaces](../../Documentation/Images/Packaging/AccessingViaInterfaces.png)

Documentation/Packaging/MRTK_Packages.md

@@ -82,5 +82,3 @@ ship as part of an application.
 
 - [Architecture Overview](../Architecture/Overview.md)
 - [Systems, Extension Services and Data Providers](../Architecture/SystemsExtensionsProviders.md)
-
-

Documentation/README_MRTKStandardShader.md

@@ -57,7 +57,7 @@ MRTK Standard shader statistics example
 ![MRTK Standard Shader Statistics](../Documentation/Images/Performance/MRTKStandardShader-Stats.PNG)
 
 > [!NOTE]
-> These results can be generated by selecting and viewing a [shader asset](https://docs.unity3d.com/Manual/class-Shader.html) in the Unity inspector, then clicking the *Compile and show code* button. 
+> These results can be generated by selecting and viewing a [shader asset](https://docs.unity3d.com/Manual/class-Shader.html) in the Unity inspector, then clicking the *Compile and show code* button.
 
 ## Lighting
 
@@ -146,7 +146,7 @@ Many mesh outline techniques are done using a [post processing](https://docs.uni
 
 [`MeshOutline.cs`](xref:Microsoft.MixedReality.Toolkit.Utilities.MeshOutline) and [`MeshOutlineHierarchy.cs`](xref:Microsoft.MixedReality.Toolkit.Utilities.MeshOutlineHierarchy) can be used to render an outline around a mesh renderer. Enabling this component introduces an additional render pass of the object being outlined, but is designed to run performantly on mobile Mixed Reality devices and does not utilize any post processes. Limitations of this effect include it not working well on objects which are not watertight (or required to be two sided) and depth sorting issues can occur on overlapping objects.
 
-The outline behaviors are designed to be used in conjunction with the MRTK/Standard shader. Outline materials are usually a solid unlit color, but can be configured to achieve a wide array of effects. The default configuration of a outline material is as follows: 
+The outline behaviors are designed to be used in conjunction with the MRTK/Standard shader. Outline materials are usually a solid unlit color, but can be configured to achieve a wide array of effects. The default configuration of a outline material is as follows:
 
 <img src="../Documentation/Images/MRTKStandardShader/MRTK_OutlineMaterial.jpg" width="450">
 
@@ -159,7 +159,7 @@ The outline behaviors are designed to be used in conjunction with the MRTK/Stand
 <img src="../Documentation/Images/MRTKStandardShader/MRTK_SmoothNormals.jpg" width="450">
 
 1. Smooth normals generated via [`MeshSmoother.cs`](xref:Microsoft.MixedReality.Toolkit.Utilities.MeshSmoother).
-2. Default normals used, notice the artifacts around the cube corners. 
+2. Default normals used, notice the artifacts around the cube corners.
 
 ### Stencil testing