diff --git a/docs/01-Camera/_category_.json b/docs/01-Camera/_category_.json deleted file mode 100644 index fd80332..0000000 --- a/docs/01-Camera/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Camera", - "link": { - "type": "generated-index", - "description": "Get started using the Reality Toolkit camera package." - } -} \ No newline at end of file diff --git a/docs/01-Camera/camera-boundary-module.md b/docs/01-Camera/camera-boundary-module.md deleted file mode 100644 index 82925a6..0000000 --- a/docs/01-Camera/camera-boundary-module.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Camera Boundary Module - -TODO diff --git a/docs/01-Camera/camera-rig-types.md b/docs/01-Camera/camera-rig-types.md deleted file mode 100644 index 62f7470..0000000 --- a/docs/01-Camera/camera-rig-types.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Camera Rig Types - -TODO diff --git a/docs/01-player/01-player-rig/_category_.json b/docs/01-player/01-player-rig/_category_.json new file mode 100644 index 0000000..e1e7265 --- /dev/null +++ b/docs/01-player/01-player-rig/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Player Rig", + "link": { + "type": "generated-index", + "description": "Learn about the player rig anatomy." + } +} \ No newline at end of file diff --git a/docs/01-Camera/camera-service.md b/docs/01-player/01-player-rig/overview.md similarity index 67% rename from docs/01-Camera/camera-service.md rename to docs/01-player/01-player-rig/overview.md index f483a11..6fb4cf1 100644 --- a/docs/01-Camera/camera-service.md +++ b/docs/01-player/01-player-rig/overview.md @@ -2,6 +2,6 @@ sidebar_position: 0 --- -# Camera Service +# Player Service TODO diff --git a/docs/01-player/_category_.json b/docs/01-player/_category_.json new file mode 100644 index 0000000..b258372 --- /dev/null +++ b/docs/01-player/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Player", + "link": { + "type": "generated-index", + "description": "Get started using the Reality Toolkit player module." + } +} \ No newline at end of file diff --git a/docs/01-player/overview.md b/docs/01-player/overview.md new file mode 100644 index 0000000..490b986 --- /dev/null +++ b/docs/01-player/overview.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 0 +--- + +# Overview + +The player module is at the heart of the toolkit. It represents the user / player in your virtual game or experience. It is how you know where the player is in 3D space and what their pose is. diff --git a/docs/02-input/_category_.json b/docs/02-input/_category_.json new file mode 100644 index 0000000..d57b942 --- /dev/null +++ b/docs/02-input/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Input", + "link": { + "type": "generated-index", + "description": "Get started using the Reality Toolkit input module." + } + } \ No newline at end of file diff --git a/docs/02-input/overview.md b/docs/02-input/overview.md new file mode 100644 index 0000000..7501942 --- /dev/null +++ b/docs/02-input/overview.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 0 +--- + +# Overview + +TODO diff --git a/docs/02-Interactions/01-interactors/_category_.json b/docs/03-interactions/01-interactors/_category_.json similarity index 100% rename from docs/02-Interactions/01-interactors/_category_.json rename to docs/03-interactions/01-interactors/_category_.json diff --git a/docs/02-Interactions/01-interactors/add-interactor.md b/docs/03-interactions/01-interactors/add-interactor.md similarity index 100% rename from docs/02-Interactions/01-interactors/add-interactor.md rename to docs/03-interactions/01-interactors/add-interactor.md diff --git a/docs/02-Interactions/01-interactors/available-interactors.md b/docs/03-interactions/01-interactors/available-interactors.md similarity index 100% rename from docs/02-Interactions/01-interactors/available-interactors.md rename to docs/03-interactions/01-interactors/available-interactors.md diff --git a/docs/02-Interactions/01-interactors/custom-interactor.md b/docs/03-interactions/01-interactors/custom-interactor.md similarity index 100% rename from docs/02-Interactions/01-interactors/custom-interactor.md rename to docs/03-interactions/01-interactors/custom-interactor.md diff --git a/docs/02-Interactions/01-interactors/img/interactors-configuration.png b/docs/03-interactions/01-interactors/img/interactors-configuration.png similarity index 100% rename from docs/02-Interactions/01-interactors/img/interactors-configuration.png rename to docs/03-interactions/01-interactors/img/interactors-configuration.png diff --git a/docs/02-Interactions/01-interactors/overview.md b/docs/03-interactions/01-interactors/overview.md similarity index 100% rename from docs/02-Interactions/01-interactors/overview.md rename to docs/03-interactions/01-interactors/overview.md diff --git a/docs/02-Interactions/02-interactables/_category_.json b/docs/03-interactions/02-interactables/_category_.json similarity index 100% rename from docs/02-Interactions/02-interactables/_category_.json rename to docs/03-interactions/02-interactables/_category_.json diff --git a/docs/02-Interactions/02-interactables/how-to-interactable.md b/docs/03-interactions/02-interactables/how-to-interactable.md similarity index 100% rename from docs/02-Interactions/02-interactables/how-to-interactable.md rename to docs/03-interactions/02-interactables/how-to-interactable.md diff --git a/docs/02-Interactions/02-interactables/img/interactable-component.png b/docs/03-interactions/02-interactables/img/interactable-component.png similarity index 100% rename from docs/02-Interactions/02-interactables/img/interactable-component.png rename to docs/03-interactions/02-interactables/img/interactable-component.png diff --git a/docs/02-Interactions/02-interactables/overview.md b/docs/03-interactions/02-interactables/overview.md similarity index 100% rename from docs/02-Interactions/02-interactables/overview.md rename to docs/03-interactions/02-interactables/overview.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/_category_.json b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/_category_.json similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/_category_.json rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/_category_.json diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/button-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/button-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/button-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/button-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/change-material-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/change-material-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/change-material-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/change-material-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/focus-hand-pose-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/focus-hand-pose-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/focus-hand-pose-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/focus-hand-pose-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/focus-lock-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/focus-lock-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/focus-lock-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/focus-lock-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/grab-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/grab-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/grab-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/grab-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/grab-hand-pose-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/grab-hand-pose-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/grab-hand-pose-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/grab-hand-pose-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/interaction-events-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/interaction-events-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/interaction-events-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/interaction-events-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/poke-response-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/poke-response-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/poke-response-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/poke-response-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/sync-controller-visualizer-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/sync-controller-visualizer-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/sync-controller-visualizer-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/sync-controller-visualizer-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/toggle-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/toggle-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/toggle-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/toggle-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/translate-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/translate-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/translate-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/translate-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/update-rigidbody-behaviour.md b/docs/03-interactions/03-interaction-behaviours/01-default-behaviours/update-rigidbody-behaviour.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/01-default-behaviours/update-rigidbody-behaviour.md rename to docs/03-interactions/03-interaction-behaviours/01-default-behaviours/update-rigidbody-behaviour.md diff --git a/docs/02-Interactions/03-interaction-behaviours/_category_.json b/docs/03-interactions/03-interaction-behaviours/_category_.json similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/_category_.json rename to docs/03-interactions/03-interaction-behaviours/_category_.json diff --git a/docs/02-Interactions/03-interaction-behaviours/custom-behaviours.md b/docs/03-interactions/03-interaction-behaviours/custom-behaviours.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/custom-behaviours.md rename to docs/03-interactions/03-interaction-behaviours/custom-behaviours.md diff --git a/docs/02-Interactions/03-interaction-behaviours/img/custom-behaviour-on-gameobject.png b/docs/03-interactions/03-interaction-behaviours/img/custom-behaviour-on-gameobject.png similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/img/custom-behaviour-on-gameobject.png rename to docs/03-interactions/03-interaction-behaviours/img/custom-behaviour-on-gameobject.png diff --git a/docs/02-Interactions/03-interaction-behaviours/overview.md b/docs/03-interactions/03-interaction-behaviours/overview.md similarity index 100% rename from docs/02-Interactions/03-interaction-behaviours/overview.md rename to docs/03-interactions/03-interaction-behaviours/overview.md diff --git a/docs/02-Interactions/04-samples/_category_.json b/docs/03-interactions/04-samples/_category_.json similarity index 100% rename from docs/02-Interactions/04-samples/_category_.json rename to docs/03-interactions/04-samples/_category_.json diff --git a/docs/02-Interactions/04-samples/img/pm-samples.png b/docs/03-interactions/04-samples/img/pm-samples.png similarity index 100% rename from docs/02-Interactions/04-samples/img/pm-samples.png rename to docs/03-interactions/04-samples/img/pm-samples.png diff --git a/docs/02-Interactions/04-samples/package-sample.md b/docs/03-interactions/04-samples/package-sample.md similarity index 100% rename from docs/02-Interactions/04-samples/package-sample.md rename to docs/03-interactions/04-samples/package-sample.md diff --git a/docs/02-Interactions/04-samples/youtube.md b/docs/03-interactions/04-samples/youtube.md similarity index 100% rename from docs/02-Interactions/04-samples/youtube.md rename to docs/03-interactions/04-samples/youtube.md diff --git a/docs/02-Interactions/_category_.json b/docs/03-interactions/_category_.json similarity index 100% rename from docs/02-Interactions/_category_.json rename to docs/03-interactions/_category_.json diff --git a/docs/02-Interactions/overview.md b/docs/03-interactions/overview.md similarity index 100% rename from docs/02-Interactions/overview.md rename to docs/03-interactions/overview.md diff --git a/docs/04-locomotion/_category_.json b/docs/04-locomotion/_category_.json new file mode 100644 index 0000000..ff21794 --- /dev/null +++ b/docs/04-locomotion/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "Locomotion", + "link": { + "type": "generated-index", + "description": "Get started using the Reality Toolkit locomotion module." + } + } \ No newline at end of file diff --git a/docs/04-locomotion/overview.md b/docs/04-locomotion/overview.md new file mode 100644 index 0000000..7501942 --- /dev/null +++ b/docs/04-locomotion/overview.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 0 +--- + +# Overview + +TODO