Various updates to the documentation (#131)

* Quick update to the documentation, removing unused files and adding content for the galactic center * Updated audio system readme and some general cleanup
microsoft · Jul 9, 2019 · f9384f8 · f9384f8
1 parent eaf9f1c
commit f9384f8
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 387 deletions.
diff --git a/Documentation/AudioSystem.md b/Documentation/AudioSystem.md
@@ -6,8 +6,6 @@ The audio system is implemented as an [IMixedRealityExtensionService](https://mi
 
 ## Audio Service
 
-### Code 
-
 The AudioService is surfaced via a generic interface `IAudioService\<EnumType>` where `EnumType` is an enum. This generic interface allows users to define their own enums for audio ids. The generic interface is then extended to a concrete interface `IAudioService`. This allows for users to define their own ids but not have to redefine the concrete type at every usage. This also allows for additional interfaces to be added to the API surface such as the `IAudioMixer`. 
 
 ### Using the AudioService
@@ -18,6 +16,6 @@ The audio service can be used by following the **service locator pattern** curre
 
 To add a new sound simply extend the `AudioId` enum found in the audio profile, and then map that enum to an audio file in the audio profile. The profile is found under *scriptable_objects/AudioServiceProfile*. Background music can be added by adding a new audio source in the core systems scene under *Managers/MusicAudioSources*.  A transition can be applied using the audio mixer found in *audio/audio_mixers/music_audio_mixer*.
 
-# See also
+## See also
 
 - [MRTK v2 documentation: IMixedRealityExtensionService](https://microsoft.github.io/MixedRealityToolkit-Unity/api/Microsoft.MixedReality.Toolkit.IMixedRealityExtensionService.html)
diff --git a/Documentation/BuildingGalaxyExplorer.md b/Documentation/BuildingGalaxyExplorer.md
@@ -4,7 +4,9 @@
 
 ## Running in Unity
 
-Note that by default when you download / clone this repository and open it in Unity, it will open a new scene. Navigate to the *Assets/scenes* folder and double-click main_scene to set up the editor properly. After that, you can hit the play button to succesfully start the experience. To enable the Diagnostics system, select the MixedRealityToolkit GameObject in the core_systems_scene and check the box "Enable Diagnostics System".
+Note that by default when you download / clone this repository and open it in Unity, it will open a new scene. Navigate to the *Assets/scenes* folder and double-click main_scene to set up the editor properly. After that, you can hit the play button to succesfully start the experience.
+
+To enable the [MRTK diagnostics system](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Diagnostics/DiagnosticsSystemGettingStarted.html), select the MixedRealityToolkit GameObject in the core_systems_scene and check the box "Enable Diagnostics System".
 
 ## Building Galaxy Explorer
 
@@ -22,7 +24,7 @@ In Visual Studio, set the configuration to *Release* for faster builds (doesn't
 
 In *File > Build Settings*:
 
-Architecture should be set to **x86**.
+Architecture should be set to **x86**. The target device should be **HoloLens**.
 
 ### Building for HoloLens 2
 
@@ -40,7 +42,7 @@ Architecture should be set to **x64**.
 
 In *File > Build Settings*:
 
-Architecture should be set to **x64** or **x86**.
+Architecture should be set to **x64** or **x86**. The target device should be **PC**.
 
 It's now possible to deploy to the emulator, a remote device, or create a Microsoft Store package to deploy at a later time.
 
@@ -80,8 +82,7 @@ Next specify the "MixedRealityModel" as shown below. Note that the 3D galaxy mod
 </Applications>
 ```
 
-# See also
+## See also
 
 - [Unity Manual: Universal Windows Platform](https://docs.unity3d.com/Manual/windowsstore-il2cpp.html)
-- For general instructions on implementing 3D launcher icons, also refer to the [Mixed Reality online documentation](https://docs.microsoft.com/en-us/windows/mixed-reality/implementing-3d-app-launchers)
-
+- For general instructions on implementing 3D launcher icons, also refer to the [Mixed Reality online documentation](https://docs.microsoft.com/en-us/windows/mixed-reality/implementing-3d-app-launchers)
diff --git a/Documentation/ForceGrabInteraction.md b/Documentation/ForceGrabInteraction.md
@@ -50,7 +50,7 @@ Each object in the solar system has an assigned `UIPreviewTarget` component that
 
 Note that some planets have moons, for example Earth, Mars and Jupiter. The moons are not visible when the planets are orbiting the sun. The `PlanetForceSolver` component shows them when a planet is in focus mode and hides them again when the planet loses focus.
 
-# See also
+## See also
 - [MRTK v2 documentation: Solvers](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/README_Solver.html)
 - [MRTK v2 documentation: ManipulationHandler](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/README_ManipulationHandler.html)
 - [Concepting and prototyping the force grab](https://docs.microsoft.com/windows/mixed-reality/galaxy-explorer-update)
diff --git a/Documentation/GalacticCenter.md b/Documentation/GalacticCenter.md
@@ -1,3 +1,11 @@
 # Galactic center
 
-![Galactic center](Images/ge_vis_galactic_center.png)
+![Galactic center](Images/ge_vis_galactic_center.png)
+
+The galactic center is similar to the [solar system](SolarSystem.md) as it is one chapter below the galaxy view. Essentially it is a galaxy POI that is an interactive scene. The scene is located in (*Assets/scenes/view_scenes/galactic_center_view_scene.unity*).
+
+It is also similar as it uses the same orbital trails and object interaction as in the solar system. Hence please see the respective documentation for details on the basic interactions.
+
+## See also
+
+- [Solar System Documentation](SolarSystem.md)
diff --git a/Documentation/Galaxy.md b/Documentation/Galaxy.md
@@ -18,6 +18,6 @@ The galaxy is the result of the following 3 layers:
 
 The galaxy itself is rendered through Unity's `DrawProcedural` via the `OnPostRender` method. `OnPostRender` is being called by the scripts attached to the camera and is used via a `RenderProxy` script to trigger the rendering process.
 
-# See also
+## See also
 
-- [Microsoft Docs: Case Study - Creating a galaxy in mixed reality](https://docs.microsoft.com/en-us/windows/mixed-reality/case-study-creating-a-galaxy-in-mixed-reality)
+- [Microsoft Docs: Case Study - Creating a galaxy in mixed reality](https://docs.microsoft.com/en-us/windows/mixed-reality/case-study-creating-a-galaxy-in-mixed-reality)
diff --git a/Documentation/Images/3Dasset_include_VS.png b/Documentation/Images/3Dasset_include_VS.png
diff --git a/Documentation/IntroFlow.md b/Documentation/IntroFlow.md
@@ -90,4 +90,4 @@ A Flowstage defines a discrete phase of the app flow. The code for this can be f
 
 ## DelayedEvents
 
-A wrapped UnityEvent that can trigger after a delay. The code for this can also be found in *FlowStage.cs*.
+A wrapped UnityEvent that can trigger after a delay. The code for this can also be found in *FlowStage.cs*.
diff --git a/Documentation/MenuSystem.md b/Documentation/MenuSystem.md
@@ -54,7 +54,7 @@ Contextual buttons only show when certain conditions are met. For desktop and gg
 
 The global button positions remain the same. The contextual buttons have their positions dynamically changed according to how many other contextual buttons are shown at any given moment. For the desktop and HoloLens(1st gen) + VR menus, the code for this resides in the managers belonging to the specific menu types. For the hand menu, this is done in the `HandMenu` component.
 
-# See also
+## See also
 
 - [MRTK v2 documentation: Hand tracking](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/InputSystem/HandTracking.html)
 - [MRTK v2 documentation: Solvers](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/mrtk_development/Documentation/README_Solver.md)

diff --git a/Documentation/PointsOfInterest.md b/Documentation/PointsOfInterest.md
@@ -1,6 +1,6 @@
 # Points of interest
 
-![Points of interest](Images/ge_app_poi.PNG)
+![Points of interest](Images/ge_app_poi.png)
 
 Points of interest (POI) enable the user to navigate to deeper levels of information within the application.
 
@@ -75,7 +75,7 @@ For the large POIs, you will need to create a new scene to transition to and lin
 
 ![](Images/ge_poi_adding_prefab_large_2.png)
 
-# See also
+## See also
 
 - [MRTK v2 documentation: Pressable button](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/README_Button.html)
 - [MRTK v2 documentation: Pointers](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/mrtk_development/Documentation/README_Pointers.md)
diff --git a/Documentation/SolarSystem.md b/Documentation/SolarSystem.md
@@ -2,6 +2,8 @@
 
 ![Solar system](Images/ge_app_solar_system.png)
 
+The solar system is one chapter below the galaxy view. Essentially it is a galaxy POI that is an interactive scene.
+
 This document describes objects and interactions in the solar system scene (*Assets/scenes/view_scenes/solar_system_view_scene.unity*).
 
 ## Planets
Original file line number	Diff line number	Diff line change
Expand Up		@@ -90,4 +90,4 @@ A Flowstage defines a discrete phase of the app flow. The code for this can be f

		## DelayedEvents

		A wrapped UnityEvent that can trigger after a delay. The code for this can also be found in FlowStage.cs.
		A wrapped UnityEvent that can trigger after a delay. The code for this can also be found in FlowStage.cs.