Skip to content

Commit 76c8281

Browse files
keveleighkeveleigh
committed
Add front matter
1 parent 1b931bb commit 76c8281

19 files changed

Lines changed: 107 additions & 0 deletions

‎docs/mrtk3-overview/api-reference.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: API reference
3+
description: MRTK3 API reference
4+
---
5+
16
# API reference — MRTK3
27

38
MRTK3 is now shipping as [a set of individually versioned packages](index.md#versioning). As a result, each MRTK3 package ships its API reference individually. Please find the links to the API references for MRTK3 packages below:

‎docs/mrtk3-overview/architecture/architecture.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Architecture overview
3+
description: Mixed Reality Toolkit 3 for developers - Architecture overview.
4+
---
5+
16
# Architecture overview — MRTK3
27

38
![Architecture MRTK3](../images/MRTK_v3_Architecture.png)

‎docs/mrtk3-overview/architecture/interactables.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Interactables
3+
description: Mixed Reality Toolkit 3 for developers - Interactables.
4+
parent: Architecture overview
5+
---
6+
17
# Interactables — MRTK3
28

39
MRTK builds on the `XRBaseInteractable` provided by Unity's XR Interaction Toolkit. The existing interactable behavior and API is fully supported in MRTK, and all of our custom interactables obey the existing XRI interactable API.

‎docs/mrtk3-overview/architecture/interactors.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Interactor architecture
3+
description: Mixed Reality Toolkit 3 for developers - Interactor architecture.
4+
parent: Architecture overview
5+
---
6+
17
# Interactor Architecture — MRTK3
28

39
MRTK builds upon the set of interactors offered by Unity's XR Interaction Toolkit. Mixed reality features like articulated hand tracking, gaze, and pinch require more elaborate interactors than the set provided with XRI by default. MRTK defines new interactor interfaces, categorized generally by the input modality, and corresponding implementations.

‎docs/mrtk3-overview/architecture/subsystems.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Subsystems
3+
description: Mixed Reality Toolkit 3 for developers - Subsystems.
4+
parent: Architecture overview
5+
---
6+
17
# Subsystems — MRTK3
28

39
MRTK3 leverages the Unity XR Subsystem Management infrastructure for writing extensible modules that can help provide cross-platform support for features like speech and hand tracking. These subsystems are initialized and loaded by Unity alongside the existing Unity-native subsystems like `XRMeshSubsystem` and `XRInputSubsystem`. See [the documentation for how Unity subsystems work](https://docs.unity3d.com/ScriptReference/UnityEngine.SubsystemsModule.html).

‎docs/mrtk3-overview/contributing.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Contributing to MRTK3
3+
description: Overview of how to contribute to the MRTK3 open source project.
4+
---
5+
16
# Contributing to MRTK3
27

38
MRTK3 is an open-source project under the MIT license. Community contributions are welcome and appreciated, both for new features and bug fixes.

‎docs/mrtk3-overview/getting-started/exploring-features/mrtk3-sample-scenes.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Exploring MRTK3 sample scenes
3+
description: Using and creating scenes in MRTK3
4+
parent: Getting started with MRTK3
5+
---
6+
17
# Exploring MRTK3 sample scenes
28

39
Unlike MRTK2, MRTK3 isn't distributed as a Unity project. Instead, MRTK3 consists of a loosely coupled collection of individual UPM packages distributed through the [Mixed Reality Feature Tool](https://learn.microsoft.com/windows/mixed-reality/develop/unity/welcome-to-mr-feature-tool), as well as through our official GitHub repository.

‎docs/mrtk3-overview/getting-started/exploring-features/mrtk3-tutorials.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: MRTK3 tutorials
3+
description: Resources for our MRTK3 tutorials
4+
parent: Getting started with MRTK3
5+
---
6+
17
# Exploring MRTK3 tutorials
28

39
Several tutorials have been created to help developers learn about MRTK3's various features and capabilities.

‎docs/mrtk3-overview/getting-started/overview.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Getting started with MRTK3
3+
description: Overview of how to get started with MRTK3
4+
---
5+
16
# Getting started with MRTK3
27

38
Welcome to the MRTK3! This guide serves as a starting point for using MRTK to build and experience your app in AR/VR. It includes resources for becoming acquainted with the building blocks of MRTK, and guides users through setting up their project to deploying on device.

‎docs/mrtk3-overview/getting-started/setting-up/setup-dev-env.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Setting up the Development Environment
3+
description: Setting up the Development Environment
4+
parent: Getting started with MRTK3
5+
---
6+
17
# Setting up your development environment
28

39
Before setting up a Unity Project with MRTK3, make sure you have the following prerequisites.

0 commit comments

Comments
 (0)