[PLAT-5388] Add getting started documentation (#239)

* Add getting started documentation * Correct create scene image * PR Feedback * Add view existing details * PR Feedback * PR Feedback
Vertexvis · Feb 4, 2025 · a61135d · a61135d
1 parent f81181f
commit a61135d
Show file tree

Hide file tree

Showing 19 changed files with 308 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,16 @@
 # Vertex Dev Dashboard
 
+The Vertex Developer Dashboard is an application designed for managing and viewing the Scenes, Files, and the Parts Library associated to your platform account.
+
+This dashboard is intended to be a lightweight option for managing this data, and as such, does not provide all of the functionality available through
+[Vertex Connect](https://vertex3d.com/products/vertex-connect). What this dashboard does provide is an easy way to manage, track, and visually inspect the
+data being brought into the Vertex Platform through a GUI. The tools provided for performing these interactions are split into focused areas. For more information on getting started with the Vertex Developer Dashboard, see the [Getting Started guide](./getting-started.md).
+
+For our multi-tenant account, the dashboard can be found at https://dashboard.developer.vertexvis.com/. Private deployments of the Vertex Platform will also
+include a custom deployment of this dashboard accessible at a URL generated as part of the initial deployment. Once this initial deployment has completed, the
+URL generated will be discoverable from Route 53 in AWS, and will contain the `dev-dashboard` prefix. This dashboard will be pre-configured to work against
+your private deployment.
+
 ## Run locally in Docker
 
 1. Copy `.env.local.template` to `.env.local` and optionally edit values

diff --git a/getting-started.md b/getting-started.md
diff --git a/public/assembly-panel.gif b/public/assembly-panel.gif
diff --git a/public/console-credentials.png b/public/console-credentials.png
diff --git a/public/create-application.png b/public/create-application.png
diff --git a/public/create-part.png b/public/create-part.png
diff --git a/public/create-scene.png b/public/create-scene.png
diff --git a/public/create-stream-key.png b/public/create-stream-key.png
diff --git a/public/create-token.png b/public/create-token.png
diff --git a/public/edit-scene.png b/public/edit-scene.png
diff --git a/public/fit-all.gif b/public/fit-all.gif
diff --git a/public/list-and-create-file.png b/public/list-and-create-file.png
diff --git a/public/model-views.gif b/public/model-views.gif
diff --git a/public/properties.gif b/public/properties.gif
diff --git a/public/reset-view.gif b/public/reset-view.gif
diff --git a/public/run-in-postman.png b/public/run-in-postman.png
diff --git a/public/scene-view-states-panel.gif b/public/scene-view-states-panel.gif
diff --git a/public/sign-in.png b/public/sign-in.png
diff --git a/public/update-camera.gif b/public/update-camera.gif