Updates to IA and styling

viamrobotics · Dec 11, 2024 · 6617e26 · 6617e26
1 parent a7ad39e
commit 6617e26
Show file tree

Hide file tree

Showing 20 changed files with 131 additions and 88 deletions.
diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss
@@ -2654,7 +2654,7 @@ span.section-overview {
     display: block !important;
   }
 
-  li.nav-fold.open-on-desktop.header-only > span > span {
+  li.nav-fold.header-only > span > span {
     text-transform: uppercase;
     font-family: Space Mono,sans-serif;
     color: #aaa;

diff --git a/docs/data-ai/data/alert-on-data.md b/docs/data-ai/data/alert-on-data.md
@@ -0,0 +1,9 @@
+---
+linkTitle: "Alert on data"
+title: "Alert on data"
+weight: 35
+layout: "docs"
+type: "docs"
+no_list: true
+description: "TODO"
+---
diff --git a/docs/data-ai/reference/_index.md b/docs/data-ai/reference/_index.md
@@ -5,6 +5,5 @@ weight: 500
 layout: "empty"
 type: "docs"
 empty_node: true
-open_on_desktop: true
 header_only: true
 ---
diff --git a/docs/dev/reference/_index.md b/docs/dev/reference/_index.md
@@ -5,6 +5,5 @@ weight: 300
 layout: "empty"
 type: "docs"
 empty_node: true
-open_on_desktop: true
 header_only: true
 ---
diff --git a/docs/manage/_index.md b/docs/manage/_index.md
@@ -1,5 +1,5 @@
 ---
-linkTitle: "Manage fleet"
+linkTitle: "Deploy & Manage"
 title: "Deploy, manage, and troubleshoot"
 weight: 300
 layout: "docs"

diff --git a/docs/manage/fleet/reuse-configuration.md b/docs/manage/fleet/reuse-configuration.md
@@ -1,7 +1,7 @@
 ---
 title: "Reuse machine configuration on many machines"
 linkTitle: "Reuse machine configuration"
-weight: 10
+weight: 20
 type: "docs"
 tags: ["data management", "data", "services"]
 images: ["/how-tos/one-to-many/new-fragment.png"]

diff --git a/docs/manage/manage/_index.md b/docs/manage/manage/_index.md
@@ -1,6 +1,6 @@
 ---
-linkTitle: "Manage"
-title: "Manage and organize"
+linkTitle: "Manage organization"
+title: "Manage and organize your organization"
 weight: 20
 layout: "empty"
 type: "docs"

diff --git a/docs/manage/reference/_index.md b/docs/manage/reference/_index.md
@@ -5,6 +5,5 @@ weight: 300
 layout: "empty"
 type: "docs"
 empty_node: true
-open_on_desktop: true
 header_only: true
 ---
diff --git a/docs/manage/reference/billing.md b/docs/manage/reference/billing.md
@@ -1,7 +1,7 @@
 ---
 title: "Payment and billing"
 linkTitle: "Billing"
-weight: 500
+weight: 50
 type: "docs"
 description: "An overview of the Payments & Billing page."
 tags: ["fleet management", "cloud", "app"]

diff --git a/docs/manage/manage/organize.md → docs/manage/reference/organize.md b/docs/manage/manage/organize.md → docs/manage/reference/organize.md
@@ -1,7 +1,7 @@
 ---
-linkTitle: "Organize your workspace"
-title: "Organize your workspace"
-weight: 10
+linkTitle: "Organize your machines"
+title: "Organize your machines"
+weight: 60
 layout: "docs"
 type: "docs"
 no_list: true

diff --git a/docs/manage/troubleshoot/teleoperate-custom.md b/docs/manage/troubleshoot/teleoperate-custom.md
@@ -0,0 +1,77 @@
+---
+title: "Teleoperate with custom control interface"
+linkTitle: "Teleoperate (custom)"
+weight: 20
+type: "docs"
+description: "Use the Viam app control tab or the Viam mobile app to monitor and remotely operate your machines."
+tags: ["teleop", "fleet management", "control", "app"]
+languages: []
+viamresources: ["sensor", "camera", "movement sensor"]
+platformarea: ["viz", "data"]
+images: ["/how-tos/teleop/full-workspace.png"]
+level: "Intermediate"
+date: "2024-11-13"
+# updated: ""  # When the content was last entirely checked
+cost: "0"
+---
+
+You can remotely control, test, and operate any configured machine using a custom control interface or the [default control interface](../teleoperate).
+
+## Custom control interface
+
+Create a custom teleop workspace to operate a machine and visualize and aggregate its data.
+
+### Prerequisites
+
+{{% expand "A configured machine with teleoperable components" %}}
+
+Make sure your machine has at least one camera, movement sensor, sensor, base, arm, board, gantry, gripper, motor or servo.
+
+See [configure a machine](/how-tos/configure/) for more information.
+
+{{% /expand%}}
+
+### Configure a workspace
+
+{{< table >}}
+{{% tablestep %}}
+**1. Create a workspace in the Viam app**
+
+Log in to the [Viam app](https://app.viam.com/).
+
+Navigate to the **FLEET** page's **TELEOP** tab.
+Create a workspace by clicking **+ Create workspace**.
+Give it a name.
+
+{{<imgproc src="/how-tos/teleop/blank-workspace.png" resize="800x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Blank teleop page.">}}
+
+{{% /tablestep %}}
+{{% tablestep %}}
+**2. Add widgets**
+
+Click **Add widget** and select the appropriate widget for your machine.
+Repeat as many times as necessary.
+
+Now your workspace setup is complete:
+
+{{<imgproc src="/how-tos/teleop/configured-workspace.png" resize="700x" style="width: 500px" class="fill aligncenter" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets.">}}
+
+{{% /tablestep %}}
+{{% tablestep %}}
+**3. Select a machine**
+
+Now, select a machine with which to make your teleop workspace come to life.
+Select **Monitor** in the top right corner to leave editing mode.
+Click **Select machine** and select your configured machine.
+
+Your dashboard now shows the configured widgets for the data from your machine:
+
+{{<imgproc src="/how-tos/teleop/full-workspace.png" resize="900x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets on monitor mode.">}}
+
+You can go back to **Edit** mode and drag and drop the widgets' panes around to edit their appearance.
+For example:
+
+{{<imgproc src="/how-tos/teleop/four-panes.png" resize="900x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets on monitor mode with four panes.">}}
+
+{{% /tablestep %}}
+{{< /table >}}
diff --git a/docs/manage/troubleshoot/teleoperate.md b/docs/manage/troubleshoot/teleoperate.md
@@ -1,7 +1,8 @@
 ---
-title: "Teleoperate"
-linkTitle: "Teleoperate"
-weight: 20
+title: "Teleoperate with the default control interface"
+linkTitle: "Teleoperate (default)"
+titleMustBeLong: true
+weight: 25
 type: "docs"
 description: "Use the Viam app control tab or the Viam mobile app to monitor and remotely operate your machines."
 tags: ["teleop", "fleet management", "control", "app"]
@@ -15,66 +16,7 @@ date: "2024-11-13"
 cost: "0"
 ---
 
-You can remotely control, test, and operate any configured machine using a [custom control interface](#custom-control-interface) or the [default control interface](#default-control-interface).
-
-## Custom control interface
-
-Create a custom teleop workspace to operate a machine and visualize and aggregate its data.
-
-### Prerequisites
-
-{{% expand "A configured machine with teleoperable components" %}}
-
-Make sure your machine has at least one camera, movement sensor, sensor, base, arm, board, gantry, gripper, motor or servo.
-
-See [configure a machine](/how-tos/configure/) for more information.
-
-{{% /expand%}}
-
-### Configure a workspace
-
-{{< table >}}
-{{% tablestep %}}
-**1. Create a workspace in the Viam app**
-
-Log in to the [Viam app](https://app.viam.com/).
-
-Navigate to the **FLEET** page's **TELEOP** tab.
-Create a workspace by clicking **+ Create workspace**.
-Give it a name.
-
-{{<imgproc src="/how-tos/teleop/blank-workspace.png" resize="800x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Blank teleop page.">}}
-
-{{% /tablestep %}}
-{{% tablestep %}}
-**2. Add widgets**
-
-Click **Add widget** and select the appropriate widget for your machine.
-Repeat as many times as necessary.
-
-Now your workspace setup is complete:
-
-{{<imgproc src="/how-tos/teleop/configured-workspace.png" resize="700x" style="width: 500px" class="fill aligncenter" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets.">}}
-
-{{% /tablestep %}}
-{{% tablestep %}}
-**3. Select a machine**
-
-Now, select a machine with which to make your teleop workspace come to life.
-Select **Monitor** in the top right corner to leave editing mode.
-Click **Select machine** and select your configured machine.
-
-Your dashboard now shows the configured widgets for the data from your machine:
-
-{{<imgproc src="/how-tos/teleop/full-workspace.png" resize="900x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets on monitor mode.">}}
-
-You can go back to **Edit** mode and drag and drop the widgets' panes around to edit their appearance.
-For example:
-
-{{<imgproc src="/how-tos/teleop/four-panes.png" resize="900x" style="width: 500px" class="fill aligncenter imgzoom" declaredimensions=true alt="Teleop workspace with values configured for each of the four widgets on monitor mode with four panes.">}}
-
-{{% /tablestep %}}
-{{< /table >}}
+You can remotely control, test, and operate any configured machine using the [default control interface](#default-control-interface) or a [custom control interface](../teleoperate-custom/).
 
 ## Default control interface
 

diff --git a/docs/operate/control/control-logic.md b/docs/operate/control/control-logic.md
@@ -0,0 +1,9 @@
+---
+linkTitle: "Create a headless app"
+title: "Create a headless app"
+weight: 30
+layout: "docs"
+type: "docs"
+no_list: true
+description: "TODO"
+---
diff --git a/docs/operate/control/desktop-app.md → docs/operate/control/kiosk-app.md b/docs/operate/control/desktop-app.md → docs/operate/control/kiosk-app.md
@@ -1,6 +1,6 @@
 ---
-linkTitle: "Create desktop/screen app"
-title: "Create desktop/screen app"
+linkTitle: "Create a kiosk app"
+title: "Create a kiosk app"
 weight: 40
 layout: "docs"
 type: "docs"

diff --git a/docs/operate/get-started/_index.md b/docs/operate/get-started/_index.md
@@ -1,5 +1,5 @@
 ---
-linkTitle: "Get Started"
+linkTitle: "Connect devices"
 title: "Get Started"
 weight: 100
 layout: "empty"

diff --git a/docs/operate/get-started/reuse-config.md b/docs/operate/get-started/reuse-config.md
@@ -4,6 +4,6 @@ title: "Reuse device configuration"
 weight: 100
 layout: "docs"
 type: "docs"
-no_list: true
-description: "TODO"
+layout: "empty"
+canonical: "/manage/fleet/reuse-configuration/"
 ---
diff --git a/docs/operate/get-started/setup.md b/docs/operate/get-started/setup.md
@@ -1,6 +1,6 @@
 ---
-linkTitle: "Set up a machine"
-title: "Set up a machine"
+linkTitle: "Start a new machine"
+title: "Start a new machine"
 weight: 10
 layout: "docs"
 type: "docs"

diff --git a/docs/operate/get-started/software-capabilities.md b/docs/operate/get-started/software-capabilities.md
@@ -7,3 +7,17 @@ type: "docs"
 no_list: true
 description: "TODO"
 ---
+
+## Augmented components
+
+Bases, failover sensors, etc
+
+## Software-only components
+
+### Generic components/services
+
+[Event manager](https://github.com/viam-labs/SAVCAM-event-manager), [ChatGPT](https://github.com/jeremyrhyde/chat-gpt-module)
+
+### Sensors
+
+Random number generator, etc
diff --git a/docs/manage/fleet/setup.md → docs/operate/get-started/system-settings.md b/docs/manage/fleet/setup.md → docs/operate/get-started/system-settings.md
@@ -1,16 +1,12 @@
 ---
 linkTitle: "Configure system settings"
 title: "Configure machine operating system settings"
-weight: 20
+weight: 50
 layout: "docs"
 type: "docs"
 description: "TODO"
 ---
 
-{{< alert title="Note" color="note" >}}
-Does this belong here or in Build & integrate?
-{{< /alert >}}
-
 
 ## Configure operating system settings
 

diff --git a/docs/operate/reference/_index.md b/docs/operate/reference/_index.md
@@ -5,6 +5,5 @@ weight: 300
 layout: "empty"
 type: "docs"
 empty_node: true
-open_on_desktop: true
 header_only: true
 ---