Chore(V2): rename Tutorials to Guides

novorender · Aug 21, 2023 · bb6c006 · bb6c006
1 parent 78278c5
commit bb6c006
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 20 deletions.
diff --git a/...ippets/tutorials/getting_started/basic.ts → ...-snippets/guides/getting_started/basic.ts b/...ippets/tutorials/getting_started/basic.ts → ...-snippets/guides/getting_started/basic.ts
diff --git a/...ippets/tutorials/getting_started/index.ts → ...-snippets/guides/getting_started/index.ts b/...ippets/tutorials/getting_started/index.ts → ...-snippets/guides/getting_started/index.ts
diff --git a/...pets/tutorials/getting_started/spheres.ts → ...nippets/guides/getting_started/spheres.ts b/...pets/tutorials/getting_started/spheres.ts → ...nippets/guides/getting_started/spheres.ts
diff --git a/v2/demo-snippets/tutorials/index.ts → v2/demo-snippets/guides/index.ts b/v2/demo-snippets/tutorials/index.ts → v2/demo-snippets/guides/index.ts
diff --git a/...nippets/tutorials/loading_scenes/index.ts → ...o-snippets/guides/loading_scenes/index.ts b/...nippets/tutorials/loading_scenes/index.ts → ...o-snippets/guides/loading_scenes/index.ts
@@ -1,10 +1,10 @@
-import { demo } from "../../demo";
-import { ViewDemoHost } from "../../hosts";
-/** Here goes  code demo code that you can see in the playground */
-import publicScene from "./public_scene.ts?raw";
-import privateScene from "./private_scene.ts?raw";
-
-export const loadingScenes = {
-  ...demo("loading_scenes", "public_scene", publicScene, ViewDemoHost, {}, "Loading public scenes."),
-  ...demo("loading_scenes", "private_scene", privateScene, ViewDemoHost, {}, "Loading private   scenes."),
-};
+import { demo } from "../../demo";
+import { ViewDemoHost } from "../../hosts";
+/** Here goes  code demo code that you can see in the playground */
+import publicScene from "./public_scene.ts?raw";
+import privateScene from "./private_scene.ts?raw";
+
+export const loadingScenes = {
+  ...demo("loading_scenes", "public_scene", publicScene, ViewDemoHost, {}, "Loading public scenes."),
+  ...demo("loading_scenes", "private_scene", privateScene, ViewDemoHost, {}, "Loading private   scenes."),
+};
diff --git a/...tutorials/loading_scenes/private_scene.ts → ...ts/guides/loading_scenes/private_scene.ts b/...tutorials/loading_scenes/private_scene.ts → ...ts/guides/loading_scenes/private_scene.ts
diff --git a/.../tutorials/loading_scenes/public_scene.ts → ...ets/guides/loading_scenes/public_scene.ts b/.../tutorials/loading_scenes/public_scene.ts → ...ets/guides/loading_scenes/public_scene.ts
diff --git a/v2/demo-snippets/index.ts b/v2/demo-snippets/index.ts
@@ -1,3 +1,3 @@
-import * as tutorials from "./tutorials";
+import * as guides from "./guides";
 
-export { tutorials };
+export { guides };
diff --git a/v2/docs/tutorials/camera-controllers.md → v2/docs/guides/camera-controllers.md b/v2/docs/tutorials/camera-controllers.md → v2/docs/guides/camera-controllers.md
diff --git a/v2/docs/tutorials/getting_started.mdx → v2/docs/guides/getting_started.mdx b/v2/docs/tutorials/getting_started.mdx → v2/docs/guides/getting_started.mdx
@@ -5,14 +5,14 @@ description: "Setting up instructions for the various Novorender packages."
 keywords: ["novorender api docs", "webgl api", "measure api", "data js api", "getting started"]
 ---
 
-import { tutorials } from "@site/demo-snippets/index";
+import { guides } from "@site/demo-snippets/index";
 
 ## Demo
 
 Only the function `main()` is included in the live editors.  
 Try changing the [background color](../webgl-api/interfaces/NovoRender.RenderSettings#background) on line 18 or the [camera controller](../webgl-api/interfaces/NovoRender.API#createcameracontroller) on line 23 in the example below.
 
-<PlaygroundComponent {...tutorials.gettingStarted.spheres} />
+<PlaygroundComponent {...guides.gettingStarted.spheres} />
 
 export const PlaygroundTip = () => (
   <div

diff --git a/v2/docs/tutorials/loading_scenes.mdx → v2/docs/guides/loading_scenes.mdx b/v2/docs/tutorials/loading_scenes.mdx → v2/docs/guides/loading_scenes.mdx
@@ -5,22 +5,22 @@ description: "Loading scenes via Data JS API or Data REST API."
 keywords: ["novorender api docs", "web api", "data js api", "loading scenes"]
 ---
 
-import { tutorials } from "@site/demo-snippets/index";
+import { guides } from "@site/demo-snippets/index";
 
 To load your own scenes we recommend that you use the [`@novorender/data-js-api`](https://docs.novorender.com/docs/data-js-api) package, but you can also use the [Novorender data REST API](https://docs.novorender.com/docs/category/data-rest-api-v1) directly if you prefer.
 We will be using the npm package in all our examples.
 
 ## Public scenes
 
-<PlaygroundComponent {...tutorials.loadingScenes.public_scene} />
+<PlaygroundComponent {...guides.loadingScenes.public_scene} />
 
 ## Private scenes
 
 Only scene related endpoints are covered by the NPM package, so for user / authentication endpoints you will have to use the REST API as well.
 
 ### Username / Password
 
-<PlaygroundComponent {...tutorials.loadingScenes.private_scene} />
+<PlaygroundComponent {...guides.loadingScenes.private_scene} />
 <br />
 
 :::note

diff --git a/v2/sidebars.js b/v2/sidebars.js
@@ -63,13 +63,13 @@ const sidebars = {
         // },
         {
           type: "category",
-          label: "Tutorials",
+          label: "Guides",
           link: {
             type: "generated-index",
-            title: "Tutorials",
+            title: "Guides",
             description: "Learn more about the different features and techniques.",
           },
-          items: [{ type: "autogenerated", dirName: "tutorials" }],
+          items: [{ type: "autogenerated", dirName: "guides" }],
         },
         // { type: "link", label: "Data Rest API", href: "/data-rest-api" },
       ],