docs: update nav order

pmndrs · Aug 1, 2024 · b92123a · b92123a
1 parent a9c4796
commit b92123a
Show file tree

Hide file tree

Showing 22 changed files with 20 additions and 51 deletions.
diff --git a/docs/advanced/performance.md b/docs/advanced/performance.md
@@ -1,7 +1,7 @@
 ---
 title: Performance
 description: Important considerations for building performant immersive web applications with react-three/xr
-nav: 15
+nav: 20
 ---
 
 All performance optimizations for non-immersive 3D web applications are also applicable for immersive XR web applications. Relevant guides on the topic of performance for 3D web applications are the [R3F performance guide](https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance), [R3F performance pitfalls](https://docs.pmnd.rs/react-three-fiber/advanced/pitfalls), and the [Threejs tips and tricks](https://discoverthreejs.com/tips-and-tricks/#performance). In general, it is good to check if your web application's performance is GPU- or CPU-bound to select the correct optimization techniques.

diff --git a/docs/advanced/pitfalls.md b/docs/advanced/pitfalls.md
@@ -1,7 +1,7 @@
 ---
 title: Pitfalls
 description: Pitfalls to avoid when building immersive web applications with react-three/xr
-nav: 14
+nav: 19
 ---
 
 ## Changing the camera position in XR

diff --git a/docs/getting-started/all-components.md b/docs/getting-started/all-components.md
@@ -1,7 +1,7 @@
 ---
 title: All Components
 description: Overview of all components offered by @react-three/xr.
-nav: 4
+nav: 5
 ---
 
 ### `XR`

diff --git a/docs/getting-started/all-hooks.md b/docs/getting-started/all-hooks.md
@@ -1,7 +1,7 @@
 ---
 title: All Hooks
 description: Overview of all hooks offered by @react-three/xr.
-nav: 5
+nav: 6
 ---
 
 ### `useXR`

diff --git a/docs/getting-started/examples.md b/docs/getting-started/examples.md
@@ -1,7 +1,7 @@
 ---
 title: Examples
 description: Examples made with @react-three/xr
-nav: 2
+nav: 3
 ---
 
 <Grid cols={2}>

diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md
@@ -1,7 +1,7 @@
 ---
 title: FAQ
 description: Frequently asked questions about react-three/xr.
-nav: 5
+nav: 7
 ---
 
 ## How can I exit an XR session?

diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md
@@ -48,7 +48,6 @@ export function App() {
 
 - 💾 [Store](../tutorials/store.md)
 - 👌 [Interactions](../tutorials/interactions.md)
-- 🔧 [Options](../tutorials/options.md)
 - 🧊 [Object Detection](../tutorials/object-detection.md)
 - ✴ [Origin](../tutorials/origin.md)
 - 🪄 [Teleport](../tutorials/teleport.md)

diff --git a/docs/getting-started/showcases.md b/docs/getting-started/showcases.md
@@ -1,7 +1,7 @@
 ---
 title: Showcases
 description: Public products build with @react-three/xr
-nav: 3
+nav: 4
 ---
 
 

diff --git a/docs/migration/from-natuerlich.md b/docs/migration/from-natuerlich.md
@@ -1,7 +1,7 @@
 ---
 title: from Natuerlich
 description: Migrate your application from natuerlich
-nav: 17
+nav: 22
 ---
 
 @react-three/xr is inspired by natuerlich, and therefore, many things are similar, especially the way interactions are handled. However, a few things have been changed and renamed.

diff --git a/docs/migration/from-react-three-xr-5.md b/docs/migration/from-react-three-xr-5.md
@@ -1,7 +1,7 @@
 ---
 title: from @react-three/xr v5
 description: Migrate your application from @react-three/xr v5
-nav: 16
+nav: 21
 ---
 
 The goal of @react-three/xr v6 is to align this library closer to the react-three ecosystem. We, therefore, focussed on supporting the react-three/fiber event handlers. Another focus of v6 is to reduce boilerplate and provide more defaults while also giving developers more access to the lower-level WebXR primitives. In combination, these changes allow developers to build XR experiences that interoperate with the whole react-three ecosystem using only a few lines of code. 

diff --git a/docs/tutorials/anchors.md b/docs/tutorials/anchors.md
@@ -1,7 +1,7 @@
 ---
 title: Anchors
 description: How to create and manage anchors in your AR experience?
-nav: 12
+nav: 15
 ---
 
 Anchors allow to anchor virtual objects into the physical world in AR experiences. `react-three/xr` offers a multitude of ways to create and manage anchors. A simple solution is `useXRAnchor`, which works similarly to `useState` as it returns the current anchor and a function to request a new anchor as a tuple.

diff --git a/docs/tutorials/custom-inputs.md b/docs/tutorials/custom-inputs.md
@@ -1,7 +1,7 @@
 ---
 title: Custom Hands/Controllers/...
 description: Customize interactions and style of inputs such as hands, controllers, and more
-nav: 12
+nav: 14
 ---
 
 @react-three/xr provides a set of default hands, controllers, transient pointers, gazes, and screen input that can be configured and completely exchanged with your own implementation. The following example shows how to configure the ray color of the ray pointer in the users hand.

diff --git a/docs/tutorials/dom-overlay.md b/docs/tutorials/dom-overlay.md
@@ -1,7 +1,7 @@
 ---
 title: Dom Overlay
 description: How to add HTML elements for hand-held AR experiences with Dom overlay?
-nav: 13
+nav: 16
 ---
 
 For hand-held AR experiences, such as those using a Smartphone, WebXR offers the dom overlay capability, allowing developers to use HTML code overlayed over the experience. In case scene 3D overlays or overlays in non-handheld AR/VR experiences are needed, check out [pmndrs/uikit](https://github.com/pmndrs/uikit).

diff --git a/docs/tutorials/gamepad.md b/docs/tutorials/gamepad.md
@@ -1,7 +1,7 @@
 ---
 title: Gamepad
 description: How to use the XRControllers gamepad?
-nav: 10
+nav: 13
 ---
 
 All XR controllers are part of the state inside the xr store. The existing controllers can be read using the `useXR` hook. Alternatively, a specific xr controller can be retrived using `useXRController("left")`.

diff --git a/docs/tutorials/guards.md b/docs/tutorials/guards.md
@@ -1,7 +1,7 @@
 ---
 title: Guards
 description: Render and show parts of your application conditionally using guards
-nav: 13
+nav: 18
 ---
 
 Guards allow to conditionally display or include content. For instance, the `IfInSessionMode` guard allows only displaying a background when the session is not an AR session. The `IfInSessionMode` can receive either a list of `allow` session modes or a list of `deny` session modes.

diff --git a/docs/tutorials/hit-test.md b/docs/tutorials/hit-test.md
@@ -1,7 +1,7 @@
 ---
 title: Hit Test
 description: How to add hit testing capabilities to your AR experiences?
-nav: 14
+nav: 17
 ---
 
 Hit testing allows to check intersections with real-world geometry in AR experiences. `@react-three/xr` provides various hooks and components for setting up hit testing.

diff --git a/docs/tutorials/interactions.md b/docs/tutorials/interactions.md
@@ -1,7 +1,7 @@
 ---
 title: Interactions
 description: Build interactions that work across XR and non-XR web applications
-nav: 6
+nav: 9
 ---
 
 @react-three/xr uses the same pointer events as @react-three/fiber, which allows building interactions that work on non-XR devices as well as XR devices. So, just like you'd expect from @react-three/fiber and everywhere else in react, interactions are built using

diff --git a/docs/tutorials/object-detection.md b/docs/tutorials/object-detection.md
@@ -1,7 +1,7 @@
 ---
 title: Object Detection
 description: Use detected objects such as meshes and planes for rendering, scene understanding, physics, and more
-nav: 11
+nav: 10
 ---
 
 @react-three/xr allows to use the devices mesh and plane detection functionality to detect the meshes and planes in the environment to modify the rendering, allow physics interactions with the environment, and more.

diff --git a/docs/tutorials/options.md b/docs/tutorials/options.md
diff --git a/docs/tutorials/origin.md b/docs/tutorials/origin.md
@@ -1,7 +1,7 @@
 ---
 title: Origin
 description: Control the user's transformation by setting the XR session origin
-nav: 8
+nav: 11
 ---
 
 The origin of an XR session is a 3D transformation that represents the position of the feet when the user recenters the session. Therefore, we recommend treating the session origin as the position of the feet. @react-three/xr provides the `XROrigin` component to control this transformation and place it anywhere inside the scene.

diff --git a/docs/tutorials/store.md b/docs/tutorials/store.md
@@ -1,7 +1,7 @@
 ---
 title: Store
 description: What is the XR Store for?
-nav: 5
+nav: 8
 ---
 
 The xr store is the central part of all `@react-three/xr` experiences and allows to configure those experiences using a large set of options, control the experience using various functions, and provide access to the current state of the xr experience.

diff --git a/docs/tutorials/teleport.md b/docs/tutorials/teleport.md
@@ -1,7 +1,7 @@
 ---
 title: Teleportation
 description: Allow users to move through the scene using teleportation
-nav: 9
+nav: 12
 ---
 
 First we need to enable the teleport pointer inside the hands and controllers.