From 8cba08aabb16884c91f61f939d7dcc5e64eb1b37 Mon Sep 17 00:00:00 2001 From: Diego Marcos Segura Date: Sat, 31 May 2025 00:09:40 -0700 Subject: [PATCH] Move docs to docs directory in site --- docs/{ => docs}/community-resources.md | 0 docs/{ => docs}/controls.md | 0 docs/{ => docs}/forge-renderer.md | 0 docs/{ => docs}/forge-viewpoint.md | 0 docs/{getting-started.md => docs/index.md} | 15 +++++++------ docs/{ => docs}/loading-splats.md | 0 docs/{ => docs}/overview.md | 0 docs/{ => docs}/packed-splats.md | 0 docs/{ => docs}/performance.md | 0 docs/{ => docs}/procedural-splats.md | 0 docs/{ => docs}/splat-editing.md | 0 docs/{ => docs}/splat-mesh.md | 0 docs/{ => docs}/system-design.md | 0 docs/index.md | 2 +- docs/overrides/partials/header.html | 2 +- mkdocs.yml | 26 +++++++++++----------- 16 files changed, 23 insertions(+), 22 deletions(-) rename docs/{ => docs}/community-resources.md (100%) rename docs/{ => docs}/controls.md (100%) rename docs/{ => docs}/forge-renderer.md (100%) rename docs/{ => docs}/forge-viewpoint.md (100%) rename docs/{getting-started.md => docs/index.md} (72%) rename docs/{ => docs}/loading-splats.md (100%) rename docs/{ => docs}/overview.md (100%) rename docs/{ => docs}/packed-splats.md (100%) rename docs/{ => docs}/performance.md (100%) rename docs/{ => docs}/procedural-splats.md (100%) rename docs/{ => docs}/splat-editing.md (100%) rename docs/{ => docs}/splat-mesh.md (100%) rename docs/{ => docs}/system-design.md (100%) diff --git a/docs/community-resources.md b/docs/docs/community-resources.md similarity index 100% rename from docs/community-resources.md rename to docs/docs/community-resources.md diff --git a/docs/controls.md b/docs/docs/controls.md similarity index 100% rename from docs/controls.md rename to docs/docs/controls.md diff --git a/docs/forge-renderer.md b/docs/docs/forge-renderer.md similarity index 100% rename from docs/forge-renderer.md rename to docs/docs/forge-renderer.md diff --git a/docs/forge-viewpoint.md b/docs/docs/forge-viewpoint.md similarity index 100% rename from docs/forge-viewpoint.md rename to docs/docs/forge-viewpoint.md diff --git a/docs/getting-started.md b/docs/docs/index.md similarity index 72% rename from docs/getting-started.md rename to docs/docs/index.md index 18cecf1..15aee86 100644 --- a/docs/getting-started.md +++ b/docs/docs/index.md @@ -9,8 +9,8 @@ Copy and paste code below in an `index.html` file or remix in the [Web Playgroun @@ -19,14 +19,15 @@ import * as THREE from "three"; import { SplatMesh } from "@worldlabsai/forge"; const scene = new THREE.Scene(); -const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000); +const camera = new THREE.PerspectiveCamera(60, window.innerWidth / window.innerHeight, 0.1, 1000); const renderer = new THREE.WebGLRenderer(); renderer.setSize(window.innerWidth, window.innerHeight); document.body.appendChild(renderer.domElement) -` -const butterfly = new SplatMesh({ url: "../assets/splats/butterfly.spz"}); + +const splatURL = "https://forge.dev/assets/splats/butterfly.spz"; +const butterfly = new SplatMesh({ url: splatURL }); butterfly.quaternion.set(1, 0, 0, 0); -butterfly.position.set(0, 0, -1); +butterfly.position.set(0, 0, -3); scene.add(butterfly); renderer.setAnimationLoop(function animate(time) { @@ -38,7 +39,7 @@ renderer.setAnimationLoop(function animate(time) { ## Install with NPM ```shell -npm install forge-dev +npm install @forge-gfx/forge ``` ## Develop and contribute to Forge diff --git a/docs/loading-splats.md b/docs/docs/loading-splats.md similarity index 100% rename from docs/loading-splats.md rename to docs/docs/loading-splats.md diff --git a/docs/overview.md b/docs/docs/overview.md similarity index 100% rename from docs/overview.md rename to docs/docs/overview.md diff --git a/docs/packed-splats.md b/docs/docs/packed-splats.md similarity index 100% rename from docs/packed-splats.md rename to docs/docs/packed-splats.md diff --git a/docs/performance.md b/docs/docs/performance.md similarity index 100% rename from docs/performance.md rename to docs/docs/performance.md diff --git a/docs/procedural-splats.md b/docs/docs/procedural-splats.md similarity index 100% rename from docs/procedural-splats.md rename to docs/docs/procedural-splats.md diff --git a/docs/splat-editing.md b/docs/docs/splat-editing.md similarity index 100% rename from docs/splat-editing.md rename to docs/docs/splat-editing.md diff --git a/docs/splat-mesh.md b/docs/docs/splat-mesh.md similarity index 100% rename from docs/splat-mesh.md rename to docs/docs/splat-mesh.md diff --git a/docs/system-design.md b/docs/docs/system-design.md similarity index 100% rename from docs/system-design.md rename to docs/docs/system-design.md diff --git a/docs/index.md b/docs/index.md index 85768bc..eba594d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,6 @@ hide:

An advanced 3D Gaussian Splatting renderer for THREE.js

- Get started → + Get started →
\ No newline at end of file diff --git a/docs/overrides/partials/header.html b/docs/overrides/partials/header.html index 0b08fcd..006baaa 100644 --- a/docs/overrides/partials/header.html +++ b/docs/overrides/partials/header.html @@ -16,7 +16,7 @@
Examples - Docs + Docs Viewer diff --git a/mkdocs.yml b/mkdocs.yml index cdedd01..051b935 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,19 +9,19 @@ extra_css: - stylesheets/forge.css nav: - Home: index.md - - Getting Started: getting-started.md - - Overview: overview.md - - System Design: system-design.md - - ForgeRenderer: forge-renderer.md - - ForgeViewpoint: forge-viewpoint.md - - SplatMesh: splat-mesh.md - - PackedSplats: packed-splats.md - - Loading Gsplats: loading-splats.md - - Procedural Splats: procedural-splats.md - - Splat RGBA-XYZ SDF editing: splat-editing.md - - Controls: controls.md - - Performance tuning: performance.md - - Community Resources: community-resources.md + - Getting Started: docs/index.md + - Overview: docs/overview.md + - System Design: docs/system-design.md + - ForgeRenderer: docs/forge-renderer.md + - ForgeViewpoint: docs/forge-viewpoint.md + - SplatMesh: docs/splat-mesh.md + - PackedSplats: docs/packed-splats.md + - Loading Gsplats: docs/loading-splats.md + - Procedural Splats: docs/procedural-splats.md + - Splat RGBA-XYZ SDF editing: docs/splat-editing.md + - Controls: docs/controls.md + - Performance tuning: docs/performance.md + - Community Resources: docs/community-resources.md markdown_extensions: - pymdownx.highlight: anchor_linenums: true