diff --git a/docs.json b/docs.json index 3b9b39cd..019d785d 100644 --- a/docs.json +++ b/docs.json @@ -7,7 +7,7 @@ "Getting Started", [ ["Overview", "/"], - ["Getting Started", "/gettingstarted"], + ["Getting Started", "/getting_started"], ["Quick Start", "/quickstart"], ["Viewer", "/viewer"], ["Camera Manipulation", "/camera_manipulation"] diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index e8688ac8..ac830908 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -1,16 +1,16 @@ -# ViewerWidget Documentation +# Quick Start -`ViewerWidget` is a simplified wrapper around the Thermion 3D viewer that makes it easy to display 3D models in your Flutter application. +If all you need is a quick and easy route to rendering a single 3D model in your Flutter application, start with `ViewerWidget`. -## Overview +This is a simplified, Flutter-only wrapper around the underlying 3D rendering API with sane defaults for most people. -`ViewerWidget` handles the setup and configuration of a Thermion viewer, including: +`ViewerWidget` handles all the setup and configuration of the underlying Thermion API, including: - Loading 3D models (glTF assets) - Configuring skyboxes and image-based lighting - Setting up camera positions and manipulators - Managing the rendering lifecycle -## Installation +## Setup Follow the steps listed in [Getting Started](./getting_started) to configure your Flutter installation and project.