Skip to content

Commit 44e1408

Browse files
added all missing links to existing md files
fixed up all links and png refs in md files added more toc files for navigation entries fixed some issues with not converted links
1 parent ffba0d2 commit 44e1408

File tree

62 files changed

+184
-89
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+184
-89
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
- name: Demos
2+
href: Demos/README.md
3+
items:
4+
- name: Standard Shader
5+
href: Demos/StandardShader/README.md
6+
- name: SDK
7+
href: SDK/README.md
8+
items:
9+
- name: Basic Introduction
10+
href: SDK/Example01-BasicIntroduction/README.md
11+
- name: Standard Assets
12+
href: StandardAssets/README.md

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Controllers/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ The framework is flexible enough to allow you to provide offsets to rotate and r
1818

1919
Using the visualizer is extremely simple, just add it to an existing GameObject in your scene and provided you have configured your controller correctly, they will simply be instantiated into the scene at runtime when controllers are detected.
2020

21-
![](External/HowTo/ControlerVisualizer/ControllerVisualizerInspector.png)
21+
![](../../../../../../External/ReadMeImages/ControllerVisualizer/ControllerVisualizerInspector.png)
2222

2323
Check the documentation on configuring Controller Profiles for more details:
2424

25-
* [MixedReality Controller Configuration Profile configuration](Assets/MixedRealityToolkit-SDK/Profiles/MixedRealityControllerConfigurationProfile.md)
25+
* [MixedReality Controller Configuration Profile configuration](../../../../Profiles/MixedRealityControllerConfigurationProfile.md)
2626

2727
### Controller Visualizer notes
2828

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
- name: UX
2+
href: UX/README.md
3+
items:
4+
- name: Interactable
5+
href: UX/Interactable/README.md
6+
- name: Prefabs
7+
href: UX/Prefabs/README.md
8+
- name: Script Controllers
9+
href: UX/Scripts/Controllers/README.md
10+
- name: Script Tooltips
11+
href: UX/Scripts/Tooltips/README.md

Assets/MixedRealityToolkit.SDK/Profiles/MixedRealityControllerConfigurationProfile.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
When you need to use input controllers for your Mixed Reality project, they are registered and configured centrally within the Controller configuration profile as you can see here:
44

5-
![](External/HowTo/ControllerConfigurationProfile/01-MixedRealityControllerConfigurationProfileInspector.png)
5+
![](../../../External/ReadMeImages/ControllerConfigurationProfile/01-MixedRealityControllerConfigurationProfileInspector.png)
66

77
This enables you to very quickly define which SDK's / controllers you want to support in your project and configure how each are intended to work.
88

99
The configuration is broken down in to several key components, as detailed below:
1010

1111
## Main Controller Template definition
1212
---
13-
![](External/HowTo/ControllerConfigurationProfile/02-ControllerTemplateDefinition.png)
13+
![](../../../External/ReadMeImages/ControllerConfigurationProfile/02-ControllerTemplateDefinition.png)
1414

1515
In the first section of the configuration, the options are detailed as follows:
1616

@@ -34,7 +34,7 @@ This enables you to add a new controller definition (detailed below) to the prof
3434

3535
## Controller Template
3636
---
37-
![](External/HowTo/ControllerConfigurationProfile/03-ControllerTemplate.png)
37+
![](../../../External/ReadMeImages/ControllerConfigurationProfile/03-ControllerTemplate.png)
3838

3939
Each controller template allows you to configure any of the supported controllers for the various SDK's that have been enabled through the Mixed Reality Toolkit.
4040
Each controller is added by SDK and the prevailing hand.
@@ -84,7 +84,7 @@ These are different for each controller type, as shown below:
8484

8585
| Motion Controller | Oculus Touch | Vive Wand |
8686
|---|---|---|
87-
|![](External/HowTo/ControllerConfigurationProfile/04-WMRInteractions.png)|![](External/HowTo/ControllerConfigurationProfile/05-OculusTouchInteractions.png)|![](External/HowTo/ControllerConfigurationProfile/06-ViveWandInteractions.png)|
87+
|![](../../../External/ReadMeImages/ControllerConfigurationProfile/04-WMRInteractions.png)|![](../../../External/ReadMeImages/ControllerConfigurationProfile/05-OculusTouchInteractions.png)|![](../../../External/ReadMeImages/ControllerConfigurationProfile/06-ViveWandInteractions.png)|
8888

8989
> In the future custom mappings may become available, for now they are defined per the devices own specification according to the input definitions set out by Unity
9090
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- name: Mixed Reality Controller Configuration Profile
2+
href: MixedRealityControllerConfigurationProfile.md
3+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
- name: Audio
2+
href: Audio/README.md
3+
- name: Fonts
4+
href: Fonts/README.md
5+
- name: Materials
6+
href: Materials/README.md
7+
- name: Models
8+
href: Models/README.md
9+
- name: Shaders
10+
href: Shaders/README.md
11+
- name: Textures
12+
href: Textures/README.md
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
- name: Features
2+
href: Features/toc.yml
3+
homepage: Features/README.md
4+
- name: Profiles
5+
href: Profiles/toc.yml
6+
homepage: Profiles/README.md
7+
- name: Standard Assets
8+
href: StandardAssets/toc.yml

Assets/MixedRealityToolkit/Definitions/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,20 @@ For specific constructs, the following information details the relationships bet
6565
### Controllers
6666

6767
The controller definition relationships are defined as shown below:
68-
![](External/ReadMeImages/MRTK-ControllerDiagram.png)
68+
![](../../../External/ReadMeImages/MRTK-ControllerDiagram.png)
6969

7070
### Headsets
7171

7272
The headset definition relationships are defined as shown below:
73-
![](External/ReadMeImages/MRTK-HeadsetDefinition.png)
73+
![](../../../External/ReadMeImages/MRTK-HeadsetDefinition.png)
7474

7575
### Internal MRTK InputActions
7676

7777
Input Actions are those internal mapped actions available to the MRTK. Each controller button would be dynamically mapped to an MRTK action for use in the SDK or output from the InputSystem.
7878

7979
These are listed as follows:
80-
![](External/ReadMeImages/MRTK-InputActions.png)
80+
![](../../../External/ReadMeImages/MRTK-InputActions.png)
8181

8282
## Additional Information
8383

84-
For additional information, please see the [MRTK vNext architecture outline](MRTK-vNext.md) and the [vNext SDK Outline](MRTK-SDK.md)
84+
For additional information, please see the [MRTK vNext architecture outline](../../../MRTK-vNext.md) and the [vNext SDK Outline](../../../MRTK-SDK.md)

Assets/MixedRealityToolkit/toc.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
- name: Definitions
2+
href: Definitions/README.md
3+
- name: Event Datum
4+
href: EventDatum/README.md
5+
- name: Interfaces
6+
href: Interfaces/README.md
7+
- name: Standard Assets
8+
href: StandardAssets/README.md
9+
- name: Utilities
10+
href: Utilities/README.md
11+
items:
12+
- name: Build And Deploy
13+
href: Utilities/BuildAndDeploy/README.md
14+
- name: Async
15+
href: Utilities/Async/ReadMe.md
16+
- name: Async License
17+
href: Utilities/Async/License.md

BreakingChanges.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Breaking Changes
2+

0 commit comments

Comments
 (0)