From 2fe596b03ac393a7820e45f75f4f450b805c29d5 Mon Sep 17 00:00:00 2001 From: Shannon Bradshaw Date: Wed, 18 Mar 2026 11:53:21 -0400 Subject: [PATCH 01/73] IA skeleton part 1: nav structure and task-oriented sections (#4836) Co-authored-by: Claude Opus 4.6 (1M context) --- assets/scss/_sidebar-tree.scss | 2 +- assets/scss/_styles_project.scss | 120 +++++++----------- config.toml | 4 +- docs/build-modules/_index.md | 9 ++ docs/build-modules/dependencies.md | 9 ++ docs/build-modules/deploy-a-module.md | 9 ++ docs/build-modules/from-hardware-to-logic.md | 9 ++ docs/build-modules/manage-modules.md | 17 +++ docs/build-modules/module-reference.md | 9 ++ docs/build-modules/platform-apis.md | 9 ++ docs/build-modules/write-a-cpp-module.md | 17 +++ docs/build-modules/write-a-driver-module.md | 9 ++ docs/build-modules/write-a-logic-module.md | 9 ++ docs/build-modules/write-an-inline-module.md | 9 ++ docs/data-ai/_index.md | 1 + docs/data/_index.md | 9 ++ docs/data/capture-sync/_index.md | 9 ++ .../advanced-data-capture-sync.md | 12 ++ .../capture-sync/capture-and-sync-data.md | 9 ++ docs/data/capture-sync/conditional-sync.md | 14 ++ docs/data/capture-sync/lorawan.md | 10 ++ docs/data/capture-sync/stop-data-capture.md | 9 ++ docs/data/capture-sync/upload-other-data.md | 13 ++ docs/data/export/_index.md | 9 ++ docs/data/export/export-data.md | 11 ++ .../data/export/sync-data-to-your-database.md | 9 ++ docs/data/filter-at-the-edge.md | 9 ++ docs/data/query/_index.md | 9 ++ docs/data/query/configure-data-pipelines.md | 9 ++ docs/data/query/hot-data-store.md | 9 ++ docs/data/query/query-data.md | 9 ++ docs/data/query/query-reference.md | 10 ++ docs/data/trigger-on-data.md | 9 ++ docs/data/visualize-data.md | 9 ++ docs/dev/tools/contributing.md | 8 ++ docs/fleet/_index.md | 9 ++ docs/fleet/change-network.md | 8 ++ docs/fleet/deploy-software.md | 8 ++ docs/fleet/end-user-setup.md | 8 ++ docs/fleet/metadata.md | 8 ++ docs/fleet/provision-devices.md | 8 ++ docs/fleet/reuse-configuration.md | 8 ++ docs/fleet/scheduled-jobs.md | 8 ++ docs/fleet/system-settings.md | 8 ++ docs/fleet/update-software.md | 8 ++ docs/foundation/_index.md | 9 ++ docs/foundation/initialize-a-viam-machine.md | 8 ++ docs/foundation/setup-micro/_index.md | 8 ++ docs/foundation/setup-micro/micro-module.md | 13 ++ .../setup-micro/micro-troubleshooting.md | 11 ++ docs/hardware/_index.md | 9 ++ docs/hardware/common-components/_index.md | 9 ++ docs/hardware/common-components/add-a-base.md | 9 ++ .../hardware/common-components/add-a-board.md | 9 ++ .../common-components/add-a-button.md | 9 ++ .../common-components/add-a-camera.md | 9 ++ .../common-components/add-a-gantry.md | 9 ++ .../common-components/add-a-generic.md | 9 ++ .../common-components/add-a-gripper.md | 9 ++ .../hardware/common-components/add-a-motor.md | 9 ++ .../add-a-movement-sensor.md | 9 ++ .../common-components/add-a-power-sensor.md | 9 ++ .../common-components/add-a-sensor.md | 9 ++ .../hardware/common-components/add-a-servo.md | 9 ++ .../common-components/add-a-switch.md | 9 ++ docs/hardware/common-components/add-an-arm.md | 9 ++ .../common-components/add-an-encoder.md | 9 ++ .../add-an-input-controller.md | 9 ++ docs/hardware/component-types.md | 9 ++ docs/hardware/configure-hardware.md | 9 ++ docs/hardware/fragments.md | 9 ++ docs/hardware/machine-configuration.md | 9 ++ docs/manage/_index.md | 1 + docs/monitor/_index.md | 9 ++ docs/monitor/alert.md | 8 ++ docs/monitor/custom-interface.md | 8 ++ docs/monitor/monitor.md | 8 ++ docs/monitor/teleoperate.md | 8 ++ docs/monitor/troubleshoot.md | 8 ++ docs/motion-planning/_index.md | 13 ++ docs/motion-planning/camera-calibration.md | 8 ++ docs/motion-planning/constraints.md | 8 ++ .../frame-system-how-to/_index.md | 8 ++ .../frame-system-how-to/arm-fixed-camera.md | 8 ++ .../frame-system-how-to/arm-gripper-camera.md | 8 ++ .../frame-system-how-to/mobile-base-arm.md | 8 ++ .../mobile-base-sensors.md | 8 ++ docs/motion-planning/frame-system.md | 8 ++ docs/motion-planning/motion-how-to/_index.md | 8 ++ .../motion-how-to/avoid-obstacles.md | 8 ++ .../motion-how-to/monitor-plan-execution.md | 8 ++ .../motion-how-to/move-arm-to-pose.md | 8 ++ .../move-arm-with-constraints.md | 8 ++ .../motion-how-to/move-gantry.md | 8 ++ .../motion-how-to/pick-an-object.md | 8 ++ .../motion-how-to/place-an-object.md | 8 ++ docs/motion-planning/obstacles.md | 8 ++ docs/motion-planning/reference/_index.md | 8 ++ docs/motion-planning/reference/algorithms.md | 8 ++ docs/motion-planning/reference/api.md | 8 ++ docs/motion-planning/reference/kinematics.md | 8 ++ .../reference/motion-service.md | 8 ++ .../reference/orientation-vectors.md | 8 ++ docs/navigation/_index.md | 13 ++ docs/navigation/how-to/_index.md | 8 ++ docs/navigation/how-to/avoid-obstacles.md | 8 ++ docs/navigation/how-to/detect-while-moving.md | 8 ++ docs/navigation/how-to/drive-the-base.md | 8 ++ .../how-to/follow-a-patrol-route.md | 8 ++ .../how-to/move-to-gps-coordinate.md | 8 ++ .../navigation/how-to/navigate-to-waypoint.md | 8 ++ docs/navigation/reference/_index.md | 8 ++ docs/navigation/reference/api.md | 8 ++ .../reference/navigation-service.md | 8 ++ docs/operate/_index.md | 1 + docs/organization/_index.md | 9 ++ docs/organization/access.md | 8 ++ docs/organization/billing.md | 8 ++ docs/organization/data-regions.md | 8 ++ docs/organization/oauth.md | 8 ++ docs/organization/rbac.md | 8 ++ docs/train/_index.md | 9 ++ docs/train/annotate-images.md | 8 ++ docs/train/automate-annotation.md | 8 ++ docs/train/create-a-dataset.md | 8 ++ docs/train/custom-training-scripts.md | 8 ++ docs/train/train-a-model.md | 8 ++ docs/try/_index.md | 9 ++ docs/try/first-project/_index.md | 8 ++ docs/try/first-project/gazebo-setup.md | 9 ++ docs/try/first-project/part-1.md | 9 ++ docs/try/first-project/part-2.md | 9 ++ docs/try/first-project/part-3.md | 9 ++ docs/try/first-project/part-4.md | 9 ++ docs/try/first-project/part-5.md | 9 ++ docs/vision/_index.md | 9 ++ docs/vision/act-on-detections.md | 8 ++ docs/vision/alert-on-detections.md | 8 ++ docs/vision/classify.md | 8 ++ docs/vision/configure.md | 8 ++ docs/vision/detect.md | 8 ++ docs/vision/measure-depth.md | 9 ++ docs/vision/track.md | 9 ++ docs/what-is-viam/_index.md | 12 ++ docs/what-is-viam/problems-viam-solves.md | 9 ++ docs/what-is-viam/what-is-viam.md | 11 ++ layouts/partials/navbar.html | 13 -- layouts/partials/sidebar-tree.html | 8 +- 148 files changed, 1300 insertions(+), 95 deletions(-) create mode 100644 docs/build-modules/_index.md create mode 100644 docs/build-modules/dependencies.md create mode 100644 docs/build-modules/deploy-a-module.md create mode 100644 docs/build-modules/from-hardware-to-logic.md create mode 100644 docs/build-modules/manage-modules.md create mode 100644 docs/build-modules/module-reference.md create mode 100644 docs/build-modules/platform-apis.md create mode 100644 docs/build-modules/write-a-cpp-module.md create mode 100644 docs/build-modules/write-a-driver-module.md create mode 100644 docs/build-modules/write-a-logic-module.md create mode 100644 docs/build-modules/write-an-inline-module.md create mode 100644 docs/data/_index.md create mode 100644 docs/data/capture-sync/_index.md create mode 100644 docs/data/capture-sync/advanced-data-capture-sync.md create mode 100644 docs/data/capture-sync/capture-and-sync-data.md create mode 100644 docs/data/capture-sync/conditional-sync.md create mode 100644 docs/data/capture-sync/lorawan.md create mode 100644 docs/data/capture-sync/stop-data-capture.md create mode 100644 docs/data/capture-sync/upload-other-data.md create mode 100644 docs/data/export/_index.md create mode 100644 docs/data/export/export-data.md create mode 100644 docs/data/export/sync-data-to-your-database.md create mode 100644 docs/data/filter-at-the-edge.md create mode 100644 docs/data/query/_index.md create mode 100644 docs/data/query/configure-data-pipelines.md create mode 100644 docs/data/query/hot-data-store.md create mode 100644 docs/data/query/query-data.md create mode 100644 docs/data/query/query-reference.md create mode 100644 docs/data/trigger-on-data.md create mode 100644 docs/data/visualize-data.md create mode 100644 docs/dev/tools/contributing.md create mode 100644 docs/fleet/_index.md create mode 100644 docs/fleet/change-network.md create mode 100644 docs/fleet/deploy-software.md create mode 100644 docs/fleet/end-user-setup.md create mode 100644 docs/fleet/metadata.md create mode 100644 docs/fleet/provision-devices.md create mode 100644 docs/fleet/reuse-configuration.md create mode 100644 docs/fleet/scheduled-jobs.md create mode 100644 docs/fleet/system-settings.md create mode 100644 docs/fleet/update-software.md create mode 100644 docs/foundation/_index.md create mode 100644 docs/foundation/initialize-a-viam-machine.md create mode 100644 docs/foundation/setup-micro/_index.md create mode 100644 docs/foundation/setup-micro/micro-module.md create mode 100644 docs/foundation/setup-micro/micro-troubleshooting.md create mode 100644 docs/hardware/_index.md create mode 100644 docs/hardware/common-components/_index.md create mode 100644 docs/hardware/common-components/add-a-base.md create mode 100644 docs/hardware/common-components/add-a-board.md create mode 100644 docs/hardware/common-components/add-a-button.md create mode 100644 docs/hardware/common-components/add-a-camera.md create mode 100644 docs/hardware/common-components/add-a-gantry.md create mode 100644 docs/hardware/common-components/add-a-generic.md create mode 100644 docs/hardware/common-components/add-a-gripper.md create mode 100644 docs/hardware/common-components/add-a-motor.md create mode 100644 docs/hardware/common-components/add-a-movement-sensor.md create mode 100644 docs/hardware/common-components/add-a-power-sensor.md create mode 100644 docs/hardware/common-components/add-a-sensor.md create mode 100644 docs/hardware/common-components/add-a-servo.md create mode 100644 docs/hardware/common-components/add-a-switch.md create mode 100644 docs/hardware/common-components/add-an-arm.md create mode 100644 docs/hardware/common-components/add-an-encoder.md create mode 100644 docs/hardware/common-components/add-an-input-controller.md create mode 100644 docs/hardware/component-types.md create mode 100644 docs/hardware/configure-hardware.md create mode 100644 docs/hardware/fragments.md create mode 100644 docs/hardware/machine-configuration.md create mode 100644 docs/monitor/_index.md create mode 100644 docs/monitor/alert.md create mode 100644 docs/monitor/custom-interface.md create mode 100644 docs/monitor/monitor.md create mode 100644 docs/monitor/teleoperate.md create mode 100644 docs/monitor/troubleshoot.md create mode 100644 docs/motion-planning/_index.md create mode 100644 docs/motion-planning/camera-calibration.md create mode 100644 docs/motion-planning/constraints.md create mode 100644 docs/motion-planning/frame-system-how-to/_index.md create mode 100644 docs/motion-planning/frame-system-how-to/arm-fixed-camera.md create mode 100644 docs/motion-planning/frame-system-how-to/arm-gripper-camera.md create mode 100644 docs/motion-planning/frame-system-how-to/mobile-base-arm.md create mode 100644 docs/motion-planning/frame-system-how-to/mobile-base-sensors.md create mode 100644 docs/motion-planning/frame-system.md create mode 100644 docs/motion-planning/motion-how-to/_index.md create mode 100644 docs/motion-planning/motion-how-to/avoid-obstacles.md create mode 100644 docs/motion-planning/motion-how-to/monitor-plan-execution.md create mode 100644 docs/motion-planning/motion-how-to/move-arm-to-pose.md create mode 100644 docs/motion-planning/motion-how-to/move-arm-with-constraints.md create mode 100644 docs/motion-planning/motion-how-to/move-gantry.md create mode 100644 docs/motion-planning/motion-how-to/pick-an-object.md create mode 100644 docs/motion-planning/motion-how-to/place-an-object.md create mode 100644 docs/motion-planning/obstacles.md create mode 100644 docs/motion-planning/reference/_index.md create mode 100644 docs/motion-planning/reference/algorithms.md create mode 100644 docs/motion-planning/reference/api.md create mode 100644 docs/motion-planning/reference/kinematics.md create mode 100644 docs/motion-planning/reference/motion-service.md create mode 100644 docs/motion-planning/reference/orientation-vectors.md create mode 100644 docs/navigation/_index.md create mode 100644 docs/navigation/how-to/_index.md create mode 100644 docs/navigation/how-to/avoid-obstacles.md create mode 100644 docs/navigation/how-to/detect-while-moving.md create mode 100644 docs/navigation/how-to/drive-the-base.md create mode 100644 docs/navigation/how-to/follow-a-patrol-route.md create mode 100644 docs/navigation/how-to/move-to-gps-coordinate.md create mode 100644 docs/navigation/how-to/navigate-to-waypoint.md create mode 100644 docs/navigation/reference/_index.md create mode 100644 docs/navigation/reference/api.md create mode 100644 docs/navigation/reference/navigation-service.md create mode 100644 docs/organization/_index.md create mode 100644 docs/organization/access.md create mode 100644 docs/organization/billing.md create mode 100644 docs/organization/data-regions.md create mode 100644 docs/organization/oauth.md create mode 100644 docs/organization/rbac.md create mode 100644 docs/train/_index.md create mode 100644 docs/train/annotate-images.md create mode 100644 docs/train/automate-annotation.md create mode 100644 docs/train/create-a-dataset.md create mode 100644 docs/train/custom-training-scripts.md create mode 100644 docs/train/train-a-model.md create mode 100644 docs/try/_index.md create mode 100644 docs/try/first-project/_index.md create mode 100644 docs/try/first-project/gazebo-setup.md create mode 100644 docs/try/first-project/part-1.md create mode 100644 docs/try/first-project/part-2.md create mode 100644 docs/try/first-project/part-3.md create mode 100644 docs/try/first-project/part-4.md create mode 100644 docs/try/first-project/part-5.md create mode 100644 docs/vision/_index.md create mode 100644 docs/vision/act-on-detections.md create mode 100644 docs/vision/alert-on-detections.md create mode 100644 docs/vision/classify.md create mode 100644 docs/vision/configure.md create mode 100644 docs/vision/detect.md create mode 100644 docs/vision/measure-depth.md create mode 100644 docs/vision/track.md create mode 100644 docs/what-is-viam/_index.md create mode 100644 docs/what-is-viam/problems-viam-solves.md create mode 100644 docs/what-is-viam/what-is-viam.md diff --git a/assets/scss/_sidebar-tree.scss b/assets/scss/_sidebar-tree.scss index 6cd2996d26..02bfe1e50b 100644 --- a/assets/scss/_sidebar-tree.scss +++ b/assets/scss/_sidebar-tree.scss @@ -187,7 +187,7 @@ li .indent { } .ul-2 > li:not(:last-child) { - padding-bottom: 8px; + padding-bottom: 2px; } } diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index 39bdc445c2..b06a7ad257 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -177,6 +177,20 @@ h7, .td-content > h3 { margin-bottom: 0.667rem; + margin-top: 1.5rem; +} + +// The float:left on ol > li::before creates floats that escape the ol's +// block formatting context. Since h3 has clear:both, it clears past those +// floats, creating an oversized gap. flow-root contains the floats in +// the ol's own BFC so they don't affect adjacent elements. +// Zero the last li's margin-bottom because flow-root prevents it from +// collapsing with the ol's margin, which would add unwanted extra space. +.td-content > ol { + display: flow-root; +} +.td-content > ol > li:last-child { + margin-bottom: 0; } /* END Adjust Heading sizes*/ @@ -3191,57 +3205,9 @@ nav { background-color: rgb(232, 232, 234); } -.second-nav { - min-width: 100%; - padding: 0.25rem 1rem; - border-top: 1px solid #e4e4e6; - border-bottom: 1px solid #e4e4e6; -} - -.second-nav > ul { - padding: 0; - padding-left: 0.25rem; - margin: 0; -} - -.second-nav > ul > li { - display: inline-block; - font-family: - "Public Sans", - -apple-system, - BlinkMacSystemFont, - "Segoe UI", - Roboto, - "Helvetica Neue", - Arial, - sans-serif, - "Apple Color Emoji", - "Segoe UI Emoji", - "Segoe UI Symbol"; - font-size: 0.875rem; - line-height: 1.25rem; - margin: 5px 0px; - font-weight: 300; -} - -.second-nav > ul > li > a { - color: #333; - padding: 5px 0.5rem; - margin-right: 0.5rem; -} - -.second-nav > ul > li > a:hover, -.second-nav > ul > li > a.active-path { - text-decoration: none; - background-color: rgba(0, 0, 0, 0.03); - border-radius: 4px; - color: #282829; - font-weight: 500; -} - @media (min-width: 768px) { .td-main main { - padding-top: 7.5rem; + padding-top: 5rem; } } @@ -3249,11 +3215,6 @@ nav { min-height: 3.5rem; } -@media (max-width: 767px) { - .second-nav { - display: none; - } -} @media (min-width: 992px) { .d-lg-block { @@ -3261,23 +3222,17 @@ nav { } } -span.section-overview { - display: none; -} ul > li.nav-fold > span > span.link-and-toggle { display: flex !important; flex-direction: row; } -ul > li.nav-fold:last-child { +ul.ul-0 > li.nav-fold:last-child { padding-bottom: 0.5rem; } @media (min-width: 768px) { - .ul-1 > li.nav-fold.hide-if-desktop { - display: none; - } #landing-page-sidebar { display: none; @@ -3290,24 +3245,38 @@ ul > li.nav-fold:last-child { li.nav-fold.header-only > span > span { color: #000000; - margin-top: 1rem; + margin-top: 0.25rem; } li.nav-fold.header-only:first-child > span > a { - margin-top: 0.5rem; + margin-top: 0.25rem; } li.nav-fold.header-only * li { text-transform: unset; } - li > span > ul.ul-2 { - padding-left: 0; + li.nav-top-section > span > span.link-and-toggle > a, + li.nav-top-section > a { + text-transform: uppercase; + font-size: 0.75rem; + letter-spacing: 0.05em; + font-weight: 600; + color: #666; + } + + li.nav-top-section > span > ul.ul-2 { + margin-left: 0.5rem; } ul.ul-2 > li > span > span { color: #282829; - font-weight: 600; + font-weight: 400; + font-size: 0.833rem; + } + + ul.ul-2 > li > a { + font-size: 0.833rem; } li.header-only > span > ul.ul-3 { @@ -3320,21 +3289,26 @@ ul > li.nav-fold:last-child { padding-left: 0.5rem; } - span.section-overview-title { - display: none; - } - .ul-1 > li.nav-fold > span > span.link-and-toggle { - display: none !important; - } .td-sidebar-nav__section .ul-1 ul.ul-2 { - padding-left: 0; + padding-left: 0.5rem; + border-left: 1px solid #e4e4e6; + margin-left: 0.5rem; } .td-sidebar-nav__section ul.ul-1 { margin-left: 0; } + + li.nav-top-section { + margin-bottom: 0.5rem; + border-bottom: 1px solid #e4e4e6; + } + + li.nav-top-section:last-child { + border-bottom: none; + } } .menu-toggle { diff --git a/config.toml b/config.toml index 2f47b84c1f..6c870a4af5 100644 --- a/config.toml +++ b/config.toml @@ -115,9 +115,9 @@ breadcrumb_disable = false footer_about_disable = false navbar_logo = true navbar_translucent_over_cover_disable = false -sidebar_menu_compact = true # When true, the section headings work like an accordian. +sidebar_menu_compact = true # When true, only the active path is expanded in the sidebar. sidebar_search_disable = true -ul_show = 3 # Always expand every first level section of the sidenav -- due to tabs, our 'first level' is 3 +ul_show = 1 # Show only top-level sections; deeper levels collapse unless active [params.ui.feedback] enable = true diff --git a/docs/build-modules/_index.md b/docs/build-modules/_index.md new file mode 100644 index 0000000000..bfe31eb1f7 --- /dev/null +++ b/docs/build-modules/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Build and Deploy Modules" +title: "Build and Deploy Modules" +weight: 60 +layout: "docs" +type: "docs" +no_list: true +description: "Understand the two kinds of modules, then write, test, and deploy your own." +--- diff --git a/docs/build-modules/dependencies.md b/docs/build-modules/dependencies.md new file mode 100644 index 0000000000..a1883e483f --- /dev/null +++ b/docs/build-modules/dependencies.md @@ -0,0 +1,9 @@ +--- +title: "Access machine resources from within a module" +linkTitle: "Module dependencies" +weight: 36 +layout: "docs" +type: "docs" +description: "From within a modular resource, you can access other machine resources using dependencies." +date: "2025-11-11" +--- diff --git a/docs/build-modules/deploy-a-module.md b/docs/build-modules/deploy-a-module.md new file mode 100644 index 0000000000..cf78f2ede2 --- /dev/null +++ b/docs/build-modules/deploy-a-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Deploy a Module" +title: "Deploy a Module" +weight: 30 +layout: "docs" +type: "docs" +description: "Package, upload, and distribute a module through the Viam registry." +date: "2025-01-30" +--- diff --git a/docs/build-modules/from-hardware-to-logic.md b/docs/build-modules/from-hardware-to-logic.md new file mode 100644 index 0000000000..ada8499bcf --- /dev/null +++ b/docs/build-modules/from-hardware-to-logic.md @@ -0,0 +1,9 @@ +--- +linkTitle: "What is a module?" +title: "What is a module?" +weight: 1 +layout: "docs" +type: "docs" +description: "Understand the two kinds of modules and how configured hardware connects to application logic." +date: "2025-03-07" +--- diff --git a/docs/build-modules/manage-modules.md b/docs/build-modules/manage-modules.md new file mode 100644 index 0000000000..c4383cb233 --- /dev/null +++ b/docs/build-modules/manage-modules.md @@ -0,0 +1,17 @@ +--- +title: "Update and manage modules you created" +linkTitle: "Update and manage modules" +type: "docs" +weight: 32 +images: ["/registry/create-module.svg"] +icon: true +tags: ["modular resources", "components", "services", "registry"] +description: "Update or delete your existing modules, or change their privacy settings." +languages: [] +viamresources: [] +platformarea: ["registry"] +level: "Beginner" +date: "2024-06-30" +# updated: "" # When the tutorial was last entirely checked +cost: "0" +--- diff --git a/docs/build-modules/module-reference.md b/docs/build-modules/module-reference.md new file mode 100644 index 0000000000..207c65ffec --- /dev/null +++ b/docs/build-modules/module-reference.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Module Reference" +title: "Module Developer Reference" +weight: 40 +layout: "docs" +type: "docs" +description: "Reference for module developers: lifecycle, interfaces, meta.json schema, CLI commands, environment variables, and registry rules." +date: "2025-03-05" +--- diff --git a/docs/build-modules/platform-apis.md b/docs/build-modules/platform-apis.md new file mode 100644 index 0000000000..dab3f8f73b --- /dev/null +++ b/docs/build-modules/platform-apis.md @@ -0,0 +1,9 @@ +--- +title: "Access platform APIs from within a module" +linkTitle: "Use platform APIs" +weight: 35 +layout: "docs" +type: "docs" +description: "Write your validate and reconfigure functions to handle dependencies in your custom modular resource." +date: "2025-11-05" +--- diff --git a/docs/build-modules/write-a-cpp-module.md b/docs/build-modules/write-a-cpp-module.md new file mode 100644 index 0000000000..c63ef578e0 --- /dev/null +++ b/docs/build-modules/write-a-cpp-module.md @@ -0,0 +1,17 @@ +--- +title: "Create a new module with C++" +linkTitle: "Create a C++ module" +type: "docs" +weight: 27 +images: ["/registry/module-puzzle-piece.svg"] +tags: ["modular resources", "components", "services", "registry"] +description: "Add support for a new component or service model by writing a module in C++." +languages: ["c++"] +viamresources: [] +platformarea: ["registry"] +level: "Intermediate" +date: "2024-07-30" +# updated: "" # When the tutorial was last entirely checked +cost: "0" +draft: true # Take out Go and Python, and check updatedness before un-drafting. +--- diff --git a/docs/build-modules/write-a-driver-module.md b/docs/build-modules/write-a-driver-module.md new file mode 100644 index 0000000000..212e601906 --- /dev/null +++ b/docs/build-modules/write-a-driver-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Write a Driver Module" +title: "Write a Driver Module" +weight: 20 +layout: "docs" +type: "docs" +description: "Build a module that implements a resource API and runs as a separate process." +date: "2025-01-30" +--- diff --git a/docs/build-modules/write-a-logic-module.md b/docs/build-modules/write-a-logic-module.md new file mode 100644 index 0000000000..74f67a7c48 --- /dev/null +++ b/docs/build-modules/write-a-logic-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Write a Logic Module" +title: "Write a Logic Module" +weight: 25 +layout: "docs" +type: "docs" +description: "Build a module that monitors sensors, coordinates components, or runs automation logic." +date: "2025-03-06" +--- diff --git a/docs/build-modules/write-an-inline-module.md b/docs/build-modules/write-an-inline-module.md new file mode 100644 index 0000000000..732b6c92d6 --- /dev/null +++ b/docs/build-modules/write-an-inline-module.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Write an Inline Module" +title: "Write an Inline Module" +weight: 10 +layout: "docs" +type: "docs" +description: "Write and deploy a custom module directly in the browser using Viam's inline module editor." +date: "2025-01-30" +--- diff --git a/docs/data-ai/_index.md b/docs/data-ai/_index.md index 07064b724e..46ac5bc443 100644 --- a/docs/data-ai/_index.md +++ b/docs/data-ai/_index.md @@ -3,6 +3,7 @@ linkTitle: "AI and Data" title: "Work with Data and AI" weight: 250 layout: "docs" +toc_hide: true type: "docs" no_list: true noedit: true diff --git a/docs/data/_index.md b/docs/data/_index.md new file mode 100644 index 0000000000..fc58ca217e --- /dev/null +++ b/docs/data/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Manage data" +title: "Manage data" +weight: 40 +layout: "docs" +type: "docs" +no_list: true +description: "Capture, query, filter, pipeline, export, and visualize data." +--- diff --git a/docs/data/capture-sync/_index.md b/docs/data/capture-sync/_index.md new file mode 100644 index 0000000000..6f817bfd6c --- /dev/null +++ b/docs/data/capture-sync/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Capture and sync" +title: "Capture and sync" +weight: 10 +layout: "docs" +type: "docs" +no_list: true +description: "Capture data from your machines and sync it to the cloud." +--- diff --git a/docs/data/capture-sync/advanced-data-capture-sync.md b/docs/data/capture-sync/advanced-data-capture-sync.md new file mode 100644 index 0000000000..0086aded3e --- /dev/null +++ b/docs/data/capture-sync/advanced-data-capture-sync.md @@ -0,0 +1,12 @@ +--- +linkTitle: "Advanced configuration" +title: "Advanced configuration" +tags: ["data management", "data", "services"] +weight: 10 +layout: "docs" +type: "docs" +platformarea: ["data"] +description: "JSON-level configuration for retention policies, sync optimization, remote parts capture, and direct MongoDB capture." +date: "2025-02-10" +updated: "2025-12-04" +--- diff --git a/docs/data/capture-sync/capture-and-sync-data.md b/docs/data/capture-sync/capture-and-sync-data.md new file mode 100644 index 0000000000..dd0753e849 --- /dev/null +++ b/docs/data/capture-sync/capture-and-sync-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Capture and sync data" +title: "Capture and sync data" +weight: 5 +layout: "docs" +type: "docs" +description: "Capture data from any resource and sync it to the cloud." +date: "2025-01-30" +--- diff --git a/docs/data/capture-sync/conditional-sync.md b/docs/data/capture-sync/conditional-sync.md new file mode 100644 index 0000000000..190fb9c31e --- /dev/null +++ b/docs/data/capture-sync/conditional-sync.md @@ -0,0 +1,14 @@ +--- +title: "Conditional sync" +linkTitle: "Conditional sync" +description: "Control when captured data syncs to the cloud using a sensor that decides whether to sync." +type: "docs" +weight: 7 +tags: ["data management", "cloud", "sync"] +images: ["/services/icons/data-cloud-sync.svg"] +icon: true +viamresources: ["sensor", "data_manager"] +platformarea: ["data", "registry"] +date: "2024-12-04" +updated: "2025-12-04" +--- diff --git a/docs/data/capture-sync/lorawan.md b/docs/data/capture-sync/lorawan.md new file mode 100644 index 0000000000..02ca4b9621 --- /dev/null +++ b/docs/data/capture-sync/lorawan.md @@ -0,0 +1,10 @@ +--- +title: "Create a LoRaWAN network" +linkTitle: "Create a LoRaWAN network" +weight: 60 +type: "docs" +description: "Configure a gateway and nodes to communicate over the LoRaWAN protocol." +tags: ["sensor", "components", "lorawan", "gateway", "node"] +icon: true +images: ["/icons/components/sensor.svg"] +--- diff --git a/docs/data/capture-sync/stop-data-capture.md b/docs/data/capture-sync/stop-data-capture.md new file mode 100644 index 0000000000..9fe502d194 --- /dev/null +++ b/docs/data/capture-sync/stop-data-capture.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Stop data capture" +title: "Stop or disable data capture" +weight: 6 +layout: "docs" +type: "docs" +description: "Stop capturing data for specific resources, all resources, or disable cloud sync." +date: "2025-01-30" +--- diff --git a/docs/data/capture-sync/upload-other-data.md b/docs/data/capture-sync/upload-other-data.md new file mode 100644 index 0000000000..35c03ed2fc --- /dev/null +++ b/docs/data/capture-sync/upload-other-data.md @@ -0,0 +1,13 @@ +--- +linkTitle: "Upload external data" +title: "Upload external data" +images: ["/services/icons/data-folder.svg"] +weight: 8 +layout: "docs" +type: "docs" +languages: ["python"] +viamresources: ["data_manager"] +date: "2024-12-04" +updated: "2025-09-11" +description: "Upload data to Viam from your local computer or mobile device using the data client API or the Viam mobile app." +--- diff --git a/docs/data/export/_index.md b/docs/data/export/_index.md new file mode 100644 index 0000000000..f4db832bdd --- /dev/null +++ b/docs/data/export/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Export and integrate" +title: "Export and integrate" +weight: 40 +layout: "docs" +type: "docs" +no_list: true +description: "Export captured data or sync it to your own database." +--- diff --git a/docs/data/export/export-data.md b/docs/data/export/export-data.md new file mode 100644 index 0000000000..f452ef13f5 --- /dev/null +++ b/docs/data/export/export-data.md @@ -0,0 +1,11 @@ +--- +linkTitle: "Export data" +title: "Export data" +weight: 50 +layout: "docs" +type: "docs" +description: "Download data from Viam using the data client API or the CLI." +tags: ["data management", "cloud", "sync"] +date: "2024-12-03" +updated: "2025-09-12" +--- diff --git a/docs/data/export/sync-data-to-your-database.md b/docs/data/export/sync-data-to-your-database.md new file mode 100644 index 0000000000..462a40d806 --- /dev/null +++ b/docs/data/export/sync-data-to-your-database.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Sync data to your database" +title: "Sync data to your database" +weight: 40 +layout: "docs" +type: "docs" +description: "Use Viam as an ingestion layer and sync captured data to your own MongoDB database." +date: "2025-01-30" +--- diff --git a/docs/data/filter-at-the-edge.md b/docs/data/filter-at-the-edge.md new file mode 100644 index 0000000000..54b819089b --- /dev/null +++ b/docs/data/filter-at-the-edge.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Filter at the edge" +title: "Filter at the edge" +weight: 50 +layout: "docs" +type: "docs" +description: "Reduce bandwidth and storage costs by filtering data on the machine before syncing to the cloud." +date: "2025-01-30" +--- diff --git a/docs/data/query/_index.md b/docs/data/query/_index.md new file mode 100644 index 0000000000..5e9cf7e936 --- /dev/null +++ b/docs/data/query/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Query" +title: "Query" +weight: 30 +layout: "docs" +type: "docs" +no_list: true +description: "Query, aggregate, and analyze captured data." +--- diff --git a/docs/data/query/configure-data-pipelines.md b/docs/data/query/configure-data-pipelines.md new file mode 100644 index 0000000000..83589542e3 --- /dev/null +++ b/docs/data/query/configure-data-pipelines.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Configure data pipelines" +title: "Configure data pipelines" +weight: 30 +layout: "docs" +type: "docs" +description: "Create scheduled MQL pipelines that automatically aggregate and summarize captured data." +date: "2025-01-30" +--- diff --git a/docs/data/query/hot-data-store.md b/docs/data/query/hot-data-store.md new file mode 100644 index 0000000000..3002539673 --- /dev/null +++ b/docs/data/query/hot-data-store.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Hot data store" +title: "Hot data store" +weight: 35 +layout: "docs" +type: "docs" +description: "Store a rolling window of recent data for fast queries while continuing to write all data to blob storage." +date: "2025-01-30" +--- diff --git a/docs/data/query/query-data.md b/docs/data/query/query-data.md new file mode 100644 index 0000000000..1ae715f4df --- /dev/null +++ b/docs/data/query/query-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Query data" +title: "Query data" +weight: 10 +layout: "docs" +type: "docs" +description: "Write SQL and MQL queries against captured data in the Viam app or programmatically." +date: "2025-01-30" +--- diff --git a/docs/data/query/query-reference.md b/docs/data/query/query-reference.md new file mode 100644 index 0000000000..4a8021f23b --- /dev/null +++ b/docs/data/query/query-reference.md @@ -0,0 +1,10 @@ +--- +linkTitle: "Query reference" +title: "Query reference" +weight: 15 +layout: "docs" +type: "docs" +date: "2024-12-03" +updated: "2025-09-12" +description: "Query reference: supported operators, SQL limitations, third-party tools, and performance best practices." +--- diff --git a/docs/data/trigger-on-data.md b/docs/data/trigger-on-data.md new file mode 100644 index 0000000000..e0901ab3d8 --- /dev/null +++ b/docs/data/trigger-on-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Trigger on data events" +title: "Trigger on data events" +weight: 60 +layout: "docs" +type: "docs" +description: "Use triggers to send email notifications or webhook requests when data from the machine is synced." +date: "2025-09-12" +--- diff --git a/docs/data/visualize-data.md b/docs/data/visualize-data.md new file mode 100644 index 0000000000..fb37abbc66 --- /dev/null +++ b/docs/data/visualize-data.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Visualize data" +title: "Visualize data" +weight: 55 +layout: "docs" +type: "docs" +description: "Build dashboards with Teleop, Grafana, or programmatic charts to visualize captured data." +date: "2025-01-30" +--- diff --git a/docs/dev/tools/contributing.md b/docs/dev/tools/contributing.md new file mode 100644 index 0000000000..2bfad2b468 --- /dev/null +++ b/docs/dev/tools/contributing.md @@ -0,0 +1,8 @@ +--- +title: "Contributing to the Docs" +linkTitle: "Contributing to the docs" +weight: 99 +type: "docs" +description: "Learn about our style guide and how to work with hugo to contribute to these docs." +toc_hide: true +--- diff --git a/docs/fleet/_index.md b/docs/fleet/_index.md new file mode 100644 index 0000000000..6fa0939554 --- /dev/null +++ b/docs/fleet/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Fleet Deployment" +title: "Fleet Deployment" +weight: 200 +layout: "docs" +type: "docs" +no_list: true +description: "Deploy machines at scale: templatize configurations with fragments, provision devices, push software updates, and manage system settings." +--- diff --git a/docs/fleet/change-network.md b/docs/fleet/change-network.md new file mode 100644 index 0000000000..70975e366e --- /dev/null +++ b/docs/fleet/change-network.md @@ -0,0 +1,8 @@ +--- +linkTitle: "change network" +title: "change network" +weight: 10 +layout: "docs" +type: "docs" +description: "change network." +--- diff --git a/docs/fleet/deploy-software.md b/docs/fleet/deploy-software.md new file mode 100644 index 0000000000..8a984858bc --- /dev/null +++ b/docs/fleet/deploy-software.md @@ -0,0 +1,8 @@ +--- +linkTitle: "deploy software" +title: "deploy software" +weight: 10 +layout: "docs" +type: "docs" +description: "deploy software." +--- diff --git a/docs/fleet/end-user-setup.md b/docs/fleet/end-user-setup.md new file mode 100644 index 0000000000..38f07699ac --- /dev/null +++ b/docs/fleet/end-user-setup.md @@ -0,0 +1,8 @@ +--- +linkTitle: "end user setup" +title: "end user setup" +weight: 10 +layout: "docs" +type: "docs" +description: "end user setup." +--- diff --git a/docs/fleet/metadata.md b/docs/fleet/metadata.md new file mode 100644 index 0000000000..ccb0594853 --- /dev/null +++ b/docs/fleet/metadata.md @@ -0,0 +1,8 @@ +--- +linkTitle: "metadata" +title: "metadata" +weight: 10 +layout: "docs" +type: "docs" +description: "metadata." +--- diff --git a/docs/fleet/provision-devices.md b/docs/fleet/provision-devices.md new file mode 100644 index 0000000000..11a2a9ef8a --- /dev/null +++ b/docs/fleet/provision-devices.md @@ -0,0 +1,8 @@ +--- +linkTitle: "provision devices" +title: "provision devices" +weight: 10 +layout: "docs" +type: "docs" +description: "provision devices." +--- diff --git a/docs/fleet/reuse-configuration.md b/docs/fleet/reuse-configuration.md new file mode 100644 index 0000000000..c82da06e65 --- /dev/null +++ b/docs/fleet/reuse-configuration.md @@ -0,0 +1,8 @@ +--- +linkTitle: "reuse configuration" +title: "reuse configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "reuse configuration." +--- diff --git a/docs/fleet/scheduled-jobs.md b/docs/fleet/scheduled-jobs.md new file mode 100644 index 0000000000..998f735744 --- /dev/null +++ b/docs/fleet/scheduled-jobs.md @@ -0,0 +1,8 @@ +--- +linkTitle: "scheduled jous" +title: "scheduled jous" +weight: 10 +layout: "docs" +type: "docs" +description: "scheduled jous." +--- diff --git a/docs/fleet/system-settings.md b/docs/fleet/system-settings.md new file mode 100644 index 0000000000..e6f1674795 --- /dev/null +++ b/docs/fleet/system-settings.md @@ -0,0 +1,8 @@ +--- +linkTitle: "system settings" +title: "system settings" +weight: 10 +layout: "docs" +type: "docs" +description: "system settings." +--- diff --git a/docs/fleet/update-software.md b/docs/fleet/update-software.md new file mode 100644 index 0000000000..3d7ff09787 --- /dev/null +++ b/docs/fleet/update-software.md @@ -0,0 +1,8 @@ +--- +linkTitle: "update software" +title: "update software" +weight: 10 +layout: "docs" +type: "docs" +description: "update software." +--- diff --git a/docs/foundation/_index.md b/docs/foundation/_index.md new file mode 100644 index 0000000000..bf2ba6becc --- /dev/null +++ b/docs/foundation/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Get Started" +title: "Get Started" +weight: 30 +layout: "docs" +type: "docs" +no_list: true +description: "Install Viam on your machine and connect it to the cloud." +--- diff --git a/docs/foundation/initialize-a-viam-machine.md b/docs/foundation/initialize-a-viam-machine.md new file mode 100644 index 0000000000..a393bace35 --- /dev/null +++ b/docs/foundation/initialize-a-viam-machine.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Initialize a Viam machine" +title: "Initialize a Viam machine" +weight: 10 +layout: "docs" +type: "docs" +description: "Initialize a Viam machine." +--- diff --git a/docs/foundation/setup-micro/_index.md b/docs/foundation/setup-micro/_index.md new file mode 100644 index 0000000000..013e87972d --- /dev/null +++ b/docs/foundation/setup-micro/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Set up micro-controller" +title: "Set up micro-controller" +weight: 20 +layout: "docs" +type: "docs" +description: "Set up micro-controller." +--- diff --git a/docs/foundation/setup-micro/micro-module.md b/docs/foundation/setup-micro/micro-module.md new file mode 100644 index 0000000000..238d6831a5 --- /dev/null +++ b/docs/foundation/setup-micro/micro-module.md @@ -0,0 +1,13 @@ +--- +title: "Create modules for ESP32 microcontrollers" +linkTitle: "Modules for ESP32" +type: "docs" +weight: 50 +images: ["/installation/thumbnails/esp32-espressif.png"] +imageAlt: "E S P 32 - espressif" +tags: ["modular resources", "components", "services", "registry"] +description: "Create your own modules for use with an Espressif ESP32 microcontroller." +languages: ["rust"] +date: "2024-12-11" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/foundation/setup-micro/micro-troubleshooting.md b/docs/foundation/setup-micro/micro-troubleshooting.md new file mode 100644 index 0000000000..55bfd1b619 --- /dev/null +++ b/docs/foundation/setup-micro/micro-troubleshooting.md @@ -0,0 +1,11 @@ +--- +title: "Micro-RDK Troubleshooting" +linkTitle: "Micro-RDK Troubleshooting" +weight: 100 +type: docs +images: ["/installation/thumbnails/install.png"] +imageAlt: "Install viam-micro-server" +description: "Troubleshooting tips and best practices for installing and using viam-micro-server or other Micro-RDK-based firmware on a microcontroller." +# date: "2024-10-07" +# updated: "" # When the content was last entirely checked +--- diff --git a/docs/hardware/_index.md b/docs/hardware/_index.md new file mode 100644 index 0000000000..0352ca461a --- /dev/null +++ b/docs/hardware/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Configure hardware" +title: "Configure hardware" +weight: 35 +layout: "docs" +type: "docs" +no_list: true +description: "Understand how Viam represents hardware, add components to your machine, and configure them." +--- diff --git a/docs/hardware/common-components/_index.md b/docs/hardware/common-components/_index.md new file mode 100644 index 0000000000..c3b20e15cb --- /dev/null +++ b/docs/hardware/common-components/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Add a component" +title: "Add a component" +weight: 20 +layout: "docs" +type: "docs" +no_list: true +description: "Step-by-step guides for adding and configuring each component type." +--- diff --git a/docs/hardware/common-components/add-a-base.md b/docs/hardware/common-components/add-a-base.md new file mode 100644 index 0000000000..5769b4e777 --- /dev/null +++ b/docs/hardware/common-components/add-a-base.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Base" +title: "Add a base" +weight: 10 +layout: "docs" +type: "docs" +description: "Add and configure a wheeled base to drive a mobile robot as a single unit." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-board.md b/docs/hardware/common-components/add-a-board.md new file mode 100644 index 0000000000..ecb2f42409 --- /dev/null +++ b/docs/hardware/common-components/add-a-board.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Board" +title: "Add a board" +weight: 15 +layout: "docs" +type: "docs" +description: "Add and configure a board component to expose GPIO pins, analog readers, and digital interrupts." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-button.md b/docs/hardware/common-components/add-a-button.md new file mode 100644 index 0000000000..6f6dae3b2e --- /dev/null +++ b/docs/hardware/common-components/add-a-button.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Button" +title: "Add a button" +weight: 20 +layout: "docs" +type: "docs" +description: "Add and configure a button component to detect presses from a physical button." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-camera.md b/docs/hardware/common-components/add-a-camera.md new file mode 100644 index 0000000000..3d81af9b0c --- /dev/null +++ b/docs/hardware/common-components/add-a-camera.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Camera" +title: "Add a camera" +weight: 25 +layout: "docs" +type: "docs" +description: "Add and configure a camera component, verify the feed, and capture an image programmatically." +date: "2025-01-30" +--- diff --git a/docs/hardware/common-components/add-a-gantry.md b/docs/hardware/common-components/add-a-gantry.md new file mode 100644 index 0000000000..2adfb1a08d --- /dev/null +++ b/docs/hardware/common-components/add-a-gantry.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Gantry" +title: "Add a gantry" +weight: 35 +layout: "docs" +type: "docs" +description: "Add and configure a gantry component for precise linear positioning along one or more axes." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-generic.md b/docs/hardware/common-components/add-a-generic.md new file mode 100644 index 0000000000..a4905c9a4a --- /dev/null +++ b/docs/hardware/common-components/add-a-generic.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Generic" +title: "Add a generic component" +weight: 40 +layout: "docs" +type: "docs" +description: "Add and configure a generic component for hardware that doesn't fit any other component type." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-gripper.md b/docs/hardware/common-components/add-a-gripper.md new file mode 100644 index 0000000000..922c797b3c --- /dev/null +++ b/docs/hardware/common-components/add-a-gripper.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Gripper" +title: "Add a gripper" +weight: 45 +layout: "docs" +type: "docs" +description: "Add and configure a gripper component to open, close, and grasp objects." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-motor.md b/docs/hardware/common-components/add-a-motor.md new file mode 100644 index 0000000000..f3f7749323 --- /dev/null +++ b/docs/hardware/common-components/add-a-motor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Motor" +title: "Add a motor" +weight: 55 +layout: "docs" +type: "docs" +description: "Add and configure a motor component controlled by GPIO pins, and test it from the Viam app." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-movement-sensor.md b/docs/hardware/common-components/add-a-movement-sensor.md new file mode 100644 index 0000000000..92214fbeb6 --- /dev/null +++ b/docs/hardware/common-components/add-a-movement-sensor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Movement sensor" +title: "Add a movement sensor" +weight: 60 +layout: "docs" +type: "docs" +description: "Add and configure a movement sensor like a GPS, IMU, or odometry source." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-power-sensor.md b/docs/hardware/common-components/add-a-power-sensor.md new file mode 100644 index 0000000000..d8d38ca511 --- /dev/null +++ b/docs/hardware/common-components/add-a-power-sensor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Power sensor" +title: "Add a power sensor" +weight: 65 +layout: "docs" +type: "docs" +description: "Add and configure a power sensor to monitor voltage, current, and power consumption." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-sensor.md b/docs/hardware/common-components/add-a-sensor.md new file mode 100644 index 0000000000..e9625920ee --- /dev/null +++ b/docs/hardware/common-components/add-a-sensor.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Sensor" +title: "Add a sensor" +weight: 70 +layout: "docs" +type: "docs" +description: "Add and configure a sensor to read environmental data like temperature, humidity, or distance." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-servo.md b/docs/hardware/common-components/add-a-servo.md new file mode 100644 index 0000000000..0f9ad1af02 --- /dev/null +++ b/docs/hardware/common-components/add-a-servo.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Servo" +title: "Add a servo" +weight: 75 +layout: "docs" +type: "docs" +description: "Add and configure a hobby servo controlled by a GPIO PWM pin." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-a-switch.md b/docs/hardware/common-components/add-a-switch.md new file mode 100644 index 0000000000..5f3f0d213c --- /dev/null +++ b/docs/hardware/common-components/add-a-switch.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Switch" +title: "Add a switch" +weight: 80 +layout: "docs" +type: "docs" +description: "Add and configure a switch component to read and set the position of a multi-position switch." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-an-arm.md b/docs/hardware/common-components/add-an-arm.md new file mode 100644 index 0000000000..238208374d --- /dev/null +++ b/docs/hardware/common-components/add-an-arm.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Arm" +title: "Add an arm" +weight: 5 +layout: "docs" +type: "docs" +description: "Add and configure a robotic arm, verify joint motion, and test end-effector positioning." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-an-encoder.md b/docs/hardware/common-components/add-an-encoder.md new file mode 100644 index 0000000000..da5e3806d0 --- /dev/null +++ b/docs/hardware/common-components/add-an-encoder.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Encoder" +title: "Add an encoder" +weight: 30 +layout: "docs" +type: "docs" +description: "Add and configure an encoder to track motor position and direction." +date: "2025-03-07" +--- diff --git a/docs/hardware/common-components/add-an-input-controller.md b/docs/hardware/common-components/add-an-input-controller.md new file mode 100644 index 0000000000..98803dfcbb --- /dev/null +++ b/docs/hardware/common-components/add-an-input-controller.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Input controller" +title: "Add an input controller" +weight: 50 +layout: "docs" +type: "docs" +description: "Add and configure a gamepad, joystick, or other input device for manual machine control." +date: "2025-03-07" +--- diff --git a/docs/hardware/component-types.md b/docs/hardware/component-types.md new file mode 100644 index 0000000000..e7233ec88a --- /dev/null +++ b/docs/hardware/component-types.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Component types" +title: "Component types" +weight: 5 +layout: "docs" +type: "docs" +description: "All the component types Viam supports and when to use each one." +date: "2025-03-07" +--- diff --git a/docs/hardware/configure-hardware.md b/docs/hardware/configure-hardware.md new file mode 100644 index 0000000000..393ad028e8 --- /dev/null +++ b/docs/hardware/configure-hardware.md @@ -0,0 +1,9 @@ +--- +linkTitle: "How components work" +title: "How components work" +weight: 1 +layout: "docs" +type: "docs" +description: "Understand how Viam represents hardware, add components to your machine, and configure them." +date: "2025-03-07" +--- diff --git a/docs/hardware/fragments.md b/docs/hardware/fragments.md new file mode 100644 index 0000000000..443f581bf9 --- /dev/null +++ b/docs/hardware/fragments.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Fragments" +title: "Fragments" +weight: 12 +layout: "docs" +type: "docs" +description: "Use, create, and share reusable hardware configurations." +date: "2025-03-07" +--- diff --git a/docs/hardware/machine-configuration.md b/docs/hardware/machine-configuration.md new file mode 100644 index 0000000000..e89bb036ff --- /dev/null +++ b/docs/hardware/machine-configuration.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Machine configuration" +title: "Machine configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "Understand the JSON configuration that defines your machine's components, and how to edit it." +date: "2025-03-07" +--- diff --git a/docs/manage/_index.md b/docs/manage/_index.md index 7f5604cdcf..00aac45a70 100644 --- a/docs/manage/_index.md +++ b/docs/manage/_index.md @@ -3,6 +3,7 @@ linkTitle: "Deploy and Manage" title: "Deploy, manage, and troubleshoot" weight: 300 layout: "docs" +toc_hide: true type: "docs" no_list: true notoc: true diff --git a/docs/monitor/_index.md b/docs/monitor/_index.md new file mode 100644 index 0000000000..8e288e0993 --- /dev/null +++ b/docs/monitor/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Monitor and Operate" +title: "Monitor and Operate" +weight: 220 +layout: "docs" +type: "docs" +no_list: true +description: "Monitor machine status, set up alerts, teleoperate machines remotely, and troubleshoot issues." +--- diff --git a/docs/monitor/alert.md b/docs/monitor/alert.md new file mode 100644 index 0000000000..fba27eba5a --- /dev/null +++ b/docs/monitor/alert.md @@ -0,0 +1,8 @@ +--- +linkTitle: "alert" +title: "alert" +weight: 10 +layout: "docs" +type: "docs" +description: "alert." +--- diff --git a/docs/monitor/custom-interface.md b/docs/monitor/custom-interface.md new file mode 100644 index 0000000000..6f7f609e23 --- /dev/null +++ b/docs/monitor/custom-interface.md @@ -0,0 +1,8 @@ +--- +linkTitle: "custom interface" +title: "custom interface" +weight: 10 +layout: "docs" +type: "docs" +description: "custom interface." +--- diff --git a/docs/monitor/monitor.md b/docs/monitor/monitor.md new file mode 100644 index 0000000000..d8560d6048 --- /dev/null +++ b/docs/monitor/monitor.md @@ -0,0 +1,8 @@ +--- +linkTitle: "monitor" +title: "monitor" +weight: 10 +layout: "docs" +type: "docs" +description: "monitor." +--- diff --git a/docs/monitor/teleoperate.md b/docs/monitor/teleoperate.md new file mode 100644 index 0000000000..4f0c085d58 --- /dev/null +++ b/docs/monitor/teleoperate.md @@ -0,0 +1,8 @@ +--- +linkTitle: "teleoperate" +title: "teleoperate" +weight: 10 +layout: "docs" +type: "docs" +description: "teleoperate." +--- diff --git a/docs/monitor/troubleshoot.md b/docs/monitor/troubleshoot.md new file mode 100644 index 0000000000..495fda9bbb --- /dev/null +++ b/docs/monitor/troubleshoot.md @@ -0,0 +1,8 @@ +--- +linkTitle: "trouuleshoot" +title: "trouuleshoot" +weight: 10 +layout: "docs" +type: "docs" +description: "trouuleshoot." +--- diff --git a/docs/motion-planning/_index.md b/docs/motion-planning/_index.md new file mode 100644 index 0000000000..3e191fc25e --- /dev/null +++ b/docs/motion-planning/_index.md @@ -0,0 +1,13 @@ +--- +linkTitle: "Motion Planning" +title: "Motion Planning" +weight: 160 +layout: "docs" +type: "docs" +no_list: true +noedit: true +open_on_desktop: true +overview: true +description: "Plan and execute collision-free movements for robot arms and gantries." +notoc: true +--- diff --git a/docs/motion-planning/camera-calibration.md b/docs/motion-planning/camera-calibration.md new file mode 100644 index 0000000000..b9dceb3ed1 --- /dev/null +++ b/docs/motion-planning/camera-calibration.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Camera Calibration" +title: "Calibrate a Camera for Motion Planning" +weight: 60 +layout: "docs" +type: "docs" +description: "Compute camera intrinsic and distortion parameters for accurate 2D-to-3D projection." +--- diff --git a/docs/motion-planning/constraints.md b/docs/motion-planning/constraints.md new file mode 100644 index 0000000000..dc1beeba65 --- /dev/null +++ b/docs/motion-planning/constraints.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Constraints" +title: "Configure Motion Constraints" +weight: 40 +layout: "docs" +type: "docs" +description: "Restrict how the arm moves between poses using linear, orientation, and collision constraints." +--- diff --git a/docs/motion-planning/frame-system-how-to/_index.md b/docs/motion-planning/frame-system-how-to/_index.md new file mode 100644 index 0000000000..4c2521956f --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Frame How-Tos" +title: "Frame System How-Tos" +weight: 15 +layout: "docs" +type: "docs" +description: "Configure the frame system for common hardware setups." +--- diff --git a/docs/motion-planning/frame-system-how-to/arm-fixed-camera.md b/docs/motion-planning/frame-system-how-to/arm-fixed-camera.md new file mode 100644 index 0000000000..0e8cf9dac0 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/arm-fixed-camera.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Arm with Fixed External Camera" +title: "Arm with Fixed External Camera" +weight: 20 +layout: "docs" +type: "docs" +description: "Configure frames for a table-mounted arm with a camera mounted separately, such as overhead or on a tripod." +--- diff --git a/docs/motion-planning/frame-system-how-to/arm-gripper-camera.md b/docs/motion-planning/frame-system-how-to/arm-gripper-camera.md new file mode 100644 index 0000000000..37333e95c8 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/arm-gripper-camera.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Arm with Gripper and Wrist Camera" +title: "Arm with Gripper and Wrist Camera" +weight: 10 +layout: "docs" +type: "docs" +description: "Configure frames for a table-mounted arm with an attached gripper and wrist-mounted camera." +--- diff --git a/docs/motion-planning/frame-system-how-to/mobile-base-arm.md b/docs/motion-planning/frame-system-how-to/mobile-base-arm.md new file mode 100644 index 0000000000..10bf3a56d3 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/mobile-base-arm.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Mobile Base with Arm" +title: "Mobile Base with Arm" +weight: 40 +layout: "docs" +type: "docs" +description: "Configure frames for a mobile base with a mounted arm, gripper, and sensors." +--- diff --git a/docs/motion-planning/frame-system-how-to/mobile-base-sensors.md b/docs/motion-planning/frame-system-how-to/mobile-base-sensors.md new file mode 100644 index 0000000000..d88c28f955 --- /dev/null +++ b/docs/motion-planning/frame-system-how-to/mobile-base-sensors.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Mobile Base with Sensors" +title: "Mobile Base with Sensors" +weight: 30 +layout: "docs" +type: "docs" +description: "Configure frames for a mobile base with mounted cameras and LIDAR sensors." +--- diff --git a/docs/motion-planning/frame-system.md b/docs/motion-planning/frame-system.md new file mode 100644 index 0000000000..62d0c80e74 --- /dev/null +++ b/docs/motion-planning/frame-system.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Frame System" +title: "Frame System" +weight: 10 +layout: "docs" +type: "docs" +description: "Build a unified coordinate tree so all components agree on where things are in physical space." +--- diff --git a/docs/motion-planning/motion-how-to/_index.md b/docs/motion-planning/motion-how-to/_index.md new file mode 100644 index 0000000000..9409167f9e --- /dev/null +++ b/docs/motion-planning/motion-how-to/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Motion How-Tos" +title: "Motion Planning How-Tos" +weight: 100 +layout: "docs" +type: "docs" +description: "Task-oriented guides for moving arms, gantries, and other kinematic chains." +--- diff --git a/docs/motion-planning/motion-how-to/avoid-obstacles.md b/docs/motion-planning/motion-how-to/avoid-obstacles.md new file mode 100644 index 0000000000..4a7684f7be --- /dev/null +++ b/docs/motion-planning/motion-how-to/avoid-obstacles.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Avoid Obstacles" +title: "Plan Collision-Free Paths" +weight: 30 +layout: "docs" +type: "docs" +description: "Configure obstacles and plan motion paths that avoid collisions." +--- diff --git a/docs/motion-planning/motion-how-to/monitor-plan-execution.md b/docs/motion-planning/motion-how-to/monitor-plan-execution.md new file mode 100644 index 0000000000..99add252ad --- /dev/null +++ b/docs/motion-planning/motion-how-to/monitor-plan-execution.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Monitor Execution" +title: "Monitor and Control Plan Execution" +weight: 70 +layout: "docs" +type: "docs" +description: "Track plan status, retrieve plan details, and stop executing plans." +--- diff --git a/docs/motion-planning/motion-how-to/move-arm-to-pose.md b/docs/motion-planning/motion-how-to/move-arm-to-pose.md new file mode 100644 index 0000000000..60955f0e47 --- /dev/null +++ b/docs/motion-planning/motion-how-to/move-arm-to-pose.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move Arm to Pose" +title: "Move an Arm to a Target Pose" +weight: 10 +layout: "docs" +type: "docs" +description: "Use the motion service to move a robot arm to a position in 3D space." +--- diff --git a/docs/motion-planning/motion-how-to/move-arm-with-constraints.md b/docs/motion-planning/motion-how-to/move-arm-with-constraints.md new file mode 100644 index 0000000000..fb7b7403ec --- /dev/null +++ b/docs/motion-planning/motion-how-to/move-arm-with-constraints.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move with Constraints" +title: "Move an Arm with Motion Constraints" +weight: 20 +layout: "docs" +type: "docs" +description: "Move an arm along a straight line or with a fixed orientation using motion constraints." +--- diff --git a/docs/motion-planning/motion-how-to/move-gantry.md b/docs/motion-planning/motion-how-to/move-gantry.md new file mode 100644 index 0000000000..3fb7863a2b --- /dev/null +++ b/docs/motion-planning/motion-how-to/move-gantry.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move a Gantry" +title: "Move a Gantry" +weight: 40 +layout: "docs" +type: "docs" +description: "Control gantry axes directly or plan complex gantry motion." +--- diff --git a/docs/motion-planning/motion-how-to/pick-an-object.md b/docs/motion-planning/motion-how-to/pick-an-object.md new file mode 100644 index 0000000000..a303e34499 --- /dev/null +++ b/docs/motion-planning/motion-how-to/pick-an-object.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Pick an Object" +title: "Pick an Object" +weight: 50 +layout: "docs" +type: "docs" +description: "Detect, localize, and grasp an object with a robot arm and gripper." +--- diff --git a/docs/motion-planning/motion-how-to/place-an-object.md b/docs/motion-planning/motion-how-to/place-an-object.md new file mode 100644 index 0000000000..15bbfe8606 --- /dev/null +++ b/docs/motion-planning/motion-how-to/place-an-object.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Place an Object" +title: "Place an Object" +weight: 60 +layout: "docs" +type: "docs" +description: "Move a grasped object to a target location and release it." +--- diff --git a/docs/motion-planning/obstacles.md b/docs/motion-planning/obstacles.md new file mode 100644 index 0000000000..6ef2e00956 --- /dev/null +++ b/docs/motion-planning/obstacles.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Obstacles" +title: "Define Obstacles" +weight: 30 +layout: "docs" +type: "docs" +description: "Define collision geometry so the motion planner computes safe, collision-free paths." +--- diff --git a/docs/motion-planning/reference/_index.md b/docs/motion-planning/reference/_index.md new file mode 100644 index 0000000000..50d20725f1 --- /dev/null +++ b/docs/motion-planning/reference/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Reference" +title: "Motion Planning Reference" +weight: 200 +layout: "docs" +type: "docs" +description: "Configuration, API, and technical reference for the motion service." +--- diff --git a/docs/motion-planning/reference/algorithms.md b/docs/motion-planning/reference/algorithms.md new file mode 100644 index 0000000000..6a0b2c707e --- /dev/null +++ b/docs/motion-planning/reference/algorithms.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Algorithms" +title: "Motion Planning Algorithms" +weight: 50 +layout: "docs" +type: "docs" +description: "How Viam's motion planner computes collision-free paths for robot arms." +--- diff --git a/docs/motion-planning/reference/api.md b/docs/motion-planning/reference/api.md new file mode 100644 index 0000000000..90cf2a08b5 --- /dev/null +++ b/docs/motion-planning/reference/api.md @@ -0,0 +1,8 @@ +--- +linkTitle: "API" +title: "Motion Service API" +weight: 20 +layout: "docs" +type: "docs" +description: "The motion service API for planning and executing component movements." +--- diff --git a/docs/motion-planning/reference/kinematics.md b/docs/motion-planning/reference/kinematics.md new file mode 100644 index 0000000000..659f34da2c --- /dev/null +++ b/docs/motion-planning/reference/kinematics.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Arm Kinematics" +title: "Arm Kinematics" +weight: 20 +layout: "docs" +type: "docs" +description: "Set up the kinematic model that describes how your arm's joints and links create motion." +--- diff --git a/docs/motion-planning/reference/motion-service.md b/docs/motion-planning/reference/motion-service.md new file mode 100644 index 0000000000..31b43d23d1 --- /dev/null +++ b/docs/motion-planning/reference/motion-service.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Motion Service" +title: "Motion Service Configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "Configure the motion service for planning and executing component movements." +--- diff --git a/docs/motion-planning/reference/orientation-vectors.md b/docs/motion-planning/reference/orientation-vectors.md new file mode 100644 index 0000000000..8807cc966e --- /dev/null +++ b/docs/motion-planning/reference/orientation-vectors.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Orientation Vectors" +title: "Orientation Vector Reference" +weight: 30 +layout: "docs" +type: "docs" +description: "Reference for specifying component orientation using orientation vectors and other rotation formats." +--- diff --git a/docs/navigation/_index.md b/docs/navigation/_index.md new file mode 100644 index 0000000000..64da7b25bf --- /dev/null +++ b/docs/navigation/_index.md @@ -0,0 +1,13 @@ +--- +linkTitle: "Navigation" +title: "Navigation" +weight: 170 +layout: "docs" +type: "docs" +no_list: true +noedit: true +open_on_desktop: true +overview: true +description: "Autonomous GPS-based navigation for mobile robot bases." +notoc: true +--- diff --git a/docs/navigation/how-to/_index.md b/docs/navigation/how-to/_index.md new file mode 100644 index 0000000000..34b4912a32 --- /dev/null +++ b/docs/navigation/how-to/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "How-Tos" +title: "Navigation How-Tos" +weight: 100 +layout: "docs" +type: "docs" +description: "Task-oriented guides for driving and navigating mobile robot bases." +--- diff --git a/docs/navigation/how-to/avoid-obstacles.md b/docs/navigation/how-to/avoid-obstacles.md new file mode 100644 index 0000000000..64e0a7e169 --- /dev/null +++ b/docs/navigation/how-to/avoid-obstacles.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Avoid Obstacles" +title: "Avoid Obstacles During Navigation" +weight: 40 +layout: "docs" +type: "docs" +description: "Configure vision-based obstacle detection for autonomous navigation." +--- diff --git a/docs/navigation/how-to/detect-while-moving.md b/docs/navigation/how-to/detect-while-moving.md new file mode 100644 index 0000000000..b63449fe48 --- /dev/null +++ b/docs/navigation/how-to/detect-while-moving.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Detect While Moving" +title: "Detect Objects While Navigating" +weight: 60 +layout: "docs" +type: "docs" +description: "Run vision services concurrently with navigation to detect and react to objects." +--- diff --git a/docs/navigation/how-to/drive-the-base.md b/docs/navigation/how-to/drive-the-base.md new file mode 100644 index 0000000000..9e1d755302 --- /dev/null +++ b/docs/navigation/how-to/drive-the-base.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Drive the Base" +title: "Drive a Mobile Base" +weight: 10 +layout: "docs" +type: "docs" +description: "Control a mobile robot base with direct movement commands." +--- diff --git a/docs/navigation/how-to/follow-a-patrol-route.md b/docs/navigation/how-to/follow-a-patrol-route.md new file mode 100644 index 0000000000..c957da3da6 --- /dev/null +++ b/docs/navigation/how-to/follow-a-patrol-route.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Follow a Patrol Route" +title: "Follow a Patrol Route" +weight: 30 +layout: "docs" +type: "docs" +description: "Define a sequence of waypoints and navigate them in a loop." +--- diff --git a/docs/navigation/how-to/move-to-gps-coordinate.md b/docs/navigation/how-to/move-to-gps-coordinate.md new file mode 100644 index 0000000000..a61e8ed846 --- /dev/null +++ b/docs/navigation/how-to/move-to-gps-coordinate.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Move to GPS Coordinate" +title: "Move to a GPS Coordinate" +weight: 50 +layout: "docs" +type: "docs" +description: "Move a base to a specific GPS coordinate using MoveOnGlobe." +--- diff --git a/docs/navigation/how-to/navigate-to-waypoint.md b/docs/navigation/how-to/navigate-to-waypoint.md new file mode 100644 index 0000000000..6a08dfcf38 --- /dev/null +++ b/docs/navigation/how-to/navigate-to-waypoint.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Navigate to Waypoint" +title: "Navigate to a Waypoint" +weight: 20 +layout: "docs" +type: "docs" +description: "Configure the navigation service and autonomously navigate to GPS waypoints." +--- diff --git a/docs/navigation/reference/_index.md b/docs/navigation/reference/_index.md new file mode 100644 index 0000000000..5f105d17d9 --- /dev/null +++ b/docs/navigation/reference/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Reference" +title: "Navigation Reference" +weight: 200 +layout: "docs" +type: "docs" +description: "Configuration and API reference for the navigation service." +--- diff --git a/docs/navigation/reference/api.md b/docs/navigation/reference/api.md new file mode 100644 index 0000000000..406f119359 --- /dev/null +++ b/docs/navigation/reference/api.md @@ -0,0 +1,8 @@ +--- +linkTitle: "API" +title: "Navigation Service API" +weight: 20 +layout: "docs" +type: "docs" +description: "The navigation service API for autonomous GPS-based navigation." +--- diff --git a/docs/navigation/reference/navigation-service.md b/docs/navigation/reference/navigation-service.md new file mode 100644 index 0000000000..4d35544526 --- /dev/null +++ b/docs/navigation/reference/navigation-service.md @@ -0,0 +1,8 @@ +--- +linkTitle: "Navigation Service" +title: "Navigation Service Configuration" +weight: 10 +layout: "docs" +type: "docs" +description: "Configure the navigation service for autonomous GPS-based waypoint navigation." +--- diff --git a/docs/operate/_index.md b/docs/operate/_index.md index 81f9881f66..df7ce3a6ad 100644 --- a/docs/operate/_index.md +++ b/docs/operate/_index.md @@ -3,6 +3,7 @@ linkTitle: "Build and Integrate" title: "Build and Integrate" weight: 150 layout: "docs" +toc_hide: true type: "docs" no_list: true noedit: true diff --git a/docs/organization/_index.md b/docs/organization/_index.md new file mode 100644 index 0000000000..058c9458fa --- /dev/null +++ b/docs/organization/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Admin and Access" +title: "Admin and Access" +weight: 225 +layout: "docs" +type: "docs" +no_list: true +description: "Manage access, roles, authentication, data regions, and billing for your organization." +--- diff --git a/docs/organization/access.md b/docs/organization/access.md new file mode 100644 index 0000000000..f8293301dd --- /dev/null +++ b/docs/organization/access.md @@ -0,0 +1,8 @@ +--- +linkTitle: "access" +title: "access" +weight: 10 +layout: "docs" +type: "docs" +description: "access." +--- diff --git a/docs/organization/billing.md b/docs/organization/billing.md new file mode 100644 index 0000000000..211c113011 --- /dev/null +++ b/docs/organization/billing.md @@ -0,0 +1,8 @@ +--- +linkTitle: "uilling" +title: "uilling" +weight: 10 +layout: "docs" +type: "docs" +description: "uilling." +--- diff --git a/docs/organization/data-regions.md b/docs/organization/data-regions.md new file mode 100644 index 0000000000..e96f0bc6e2 --- /dev/null +++ b/docs/organization/data-regions.md @@ -0,0 +1,8 @@ +--- +linkTitle: "data regions" +title: "data regions" +weight: 10 +layout: "docs" +type: "docs" +description: "data regions." +--- diff --git a/docs/organization/oauth.md b/docs/organization/oauth.md new file mode 100644 index 0000000000..07c35cd5c2 --- /dev/null +++ b/docs/organization/oauth.md @@ -0,0 +1,8 @@ +--- +linkTitle: "oauth" +title: "oauth" +weight: 10 +layout: "docs" +type: "docs" +description: "oauth." +--- diff --git a/docs/organization/rbac.md b/docs/organization/rbac.md new file mode 100644 index 0000000000..f3eeb72a26 --- /dev/null +++ b/docs/organization/rbac.md @@ -0,0 +1,8 @@ +--- +linkTitle: "ruac" +title: "ruac" +weight: 10 +layout: "docs" +type: "docs" +description: "ruac." +--- diff --git a/docs/train/_index.md b/docs/train/_index.md new file mode 100644 index 0000000000..d510b6e0ff --- /dev/null +++ b/docs/train/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Train ML Models" +title: "Train ML Models" +weight: 50 +layout: "docs" +type: "docs" +no_list: true +description: "Create datasets and train ML models from captured data." +--- diff --git a/docs/train/annotate-images.md b/docs/train/annotate-images.md new file mode 100644 index 0000000000..cdadafab30 --- /dev/null +++ b/docs/train/annotate-images.md @@ -0,0 +1,8 @@ +--- +linkTitle: "annotate images" +title: "annotate images" +weight: 10 +layout: "docs" +type: "docs" +description: "annotate images." +--- diff --git a/docs/train/automate-annotation.md b/docs/train/automate-annotation.md new file mode 100644 index 0000000000..ba4fc89918 --- /dev/null +++ b/docs/train/automate-annotation.md @@ -0,0 +1,8 @@ +--- +linkTitle: "automate annotation" +title: "automate annotation" +weight: 10 +layout: "docs" +type: "docs" +description: "automate annotation." +--- diff --git a/docs/train/create-a-dataset.md b/docs/train/create-a-dataset.md new file mode 100644 index 0000000000..1d8739b40a --- /dev/null +++ b/docs/train/create-a-dataset.md @@ -0,0 +1,8 @@ +--- +linkTitle: "create a dataset" +title: "create a dataset" +weight: 10 +layout: "docs" +type: "docs" +description: "create a dataset." +--- diff --git a/docs/train/custom-training-scripts.md b/docs/train/custom-training-scripts.md new file mode 100644 index 0000000000..8d2853a675 --- /dev/null +++ b/docs/train/custom-training-scripts.md @@ -0,0 +1,8 @@ +--- +linkTitle: "custom training scripts" +title: "custom training scripts" +weight: 10 +layout: "docs" +type: "docs" +description: "custom training scripts." +--- diff --git a/docs/train/train-a-model.md b/docs/train/train-a-model.md new file mode 100644 index 0000000000..e2dff25726 --- /dev/null +++ b/docs/train/train-a-model.md @@ -0,0 +1,8 @@ +--- +linkTitle: "train a model" +title: "train a model" +weight: 10 +layout: "docs" +type: "docs" +description: "train a model." +--- diff --git a/docs/try/_index.md b/docs/try/_index.md new file mode 100644 index 0000000000..2bf641118d --- /dev/null +++ b/docs/try/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Try" +title: "Try Viam" +weight: 20 +layout: "docs" +type: "docs" +no_list: true +description: "Hands-on guided tutorials to experience Viam end-to-end." +--- diff --git a/docs/try/first-project/_index.md b/docs/try/first-project/_index.md new file mode 100644 index 0000000000..524a72ae9c --- /dev/null +++ b/docs/try/first-project/_index.md @@ -0,0 +1,8 @@ +--- +linkTitle: "First project" +title: "First project" +weight: 10 +layout: "docs" +type: "docs" +description: "First project." +--- diff --git a/docs/try/first-project/gazebo-setup.md b/docs/try/first-project/gazebo-setup.md new file mode 100644 index 0000000000..38b6a38e9e --- /dev/null +++ b/docs/try/first-project/gazebo-setup.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Gazebo Simulation Setup" +title: "Gazebo Simulation Setup" +weight: 100 +layout: "docs" +type: "docs" +description: "Set up the Gazebo simulation environment for the inspection tutorial." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-1.md b/docs/try/first-project/part-1.md new file mode 100644 index 0000000000..c612b276d6 --- /dev/null +++ b/docs/try/first-project/part-1.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 1: Vision Pipeline" +title: "Part 1: Vision Pipeline" +weight: 10 +layout: "docs" +type: "docs" +description: "Set up a camera, ML model, and vision service to detect defects." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-2.md b/docs/try/first-project/part-2.md new file mode 100644 index 0000000000..8dc2ddebc1 --- /dev/null +++ b/docs/try/first-project/part-2.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 2: Data Capture" +title: "Part 2: Data Capture" +weight: 20 +layout: "docs" +type: "docs" +description: "Configure automatic image capture and cloud sync for your inspection system." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-3.md b/docs/try/first-project/part-3.md new file mode 100644 index 0000000000..1579de9193 --- /dev/null +++ b/docs/try/first-project/part-3.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 3: Control Logic" +title: "Part 3: Control Logic" +weight: 30 +layout: "docs" +type: "docs" +description: "Write inspection logic that detects defective cans." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-4.md b/docs/try/first-project/part-4.md new file mode 100644 index 0000000000..bdb30f35cb --- /dev/null +++ b/docs/try/first-project/part-4.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 4: Deploy a Module" +title: "Part 4: Deploy a Module" +weight: 40 +layout: "docs" +type: "docs" +description: "Deploy your inspector module and configure queryable detection data capture." +date: "2025-01-30" +--- diff --git a/docs/try/first-project/part-5.md b/docs/try/first-project/part-5.md new file mode 100644 index 0000000000..93b079c736 --- /dev/null +++ b/docs/try/first-project/part-5.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Part 5: Productize" +title: "Part 5: Productize" +weight: 50 +layout: "docs" +type: "docs" +description: "Build a monitoring dashboard for your inspection system using Viam's Teleop interface." +date: "2025-01-30" +--- diff --git a/docs/vision/_index.md b/docs/vision/_index.md new file mode 100644 index 0000000000..72395b2b3a --- /dev/null +++ b/docs/vision/_index.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Computer Vision" +title: "Computer Vision" +weight: 55 +layout: "docs" +type: "docs" +no_list: true +description: "Add computer vision to your machine: deploy ML models, detect and classify objects, measure depth, and act or alert on results." +--- diff --git a/docs/vision/act-on-detections.md b/docs/vision/act-on-detections.md new file mode 100644 index 0000000000..a2eb02c06a --- /dev/null +++ b/docs/vision/act-on-detections.md @@ -0,0 +1,8 @@ +--- +linkTitle: "act on detections" +title: "act on detections" +weight: 10 +layout: "docs" +type: "docs" +description: "act on detections." +--- diff --git a/docs/vision/alert-on-detections.md b/docs/vision/alert-on-detections.md new file mode 100644 index 0000000000..c72d91469f --- /dev/null +++ b/docs/vision/alert-on-detections.md @@ -0,0 +1,8 @@ +--- +linkTitle: "alert on detections" +title: "alert on detections" +weight: 10 +layout: "docs" +type: "docs" +description: "alert on detections." +--- diff --git a/docs/vision/classify.md b/docs/vision/classify.md new file mode 100644 index 0000000000..31658a7f43 --- /dev/null +++ b/docs/vision/classify.md @@ -0,0 +1,8 @@ +--- +linkTitle: "classify" +title: "classify" +weight: 10 +layout: "docs" +type: "docs" +description: "classify." +--- diff --git a/docs/vision/configure.md b/docs/vision/configure.md new file mode 100644 index 0000000000..5970095410 --- /dev/null +++ b/docs/vision/configure.md @@ -0,0 +1,8 @@ +--- +linkTitle: "configure" +title: "configure" +weight: 10 +layout: "docs" +type: "docs" +description: "configure." +--- diff --git a/docs/vision/detect.md b/docs/vision/detect.md new file mode 100644 index 0000000000..5d0f6df874 --- /dev/null +++ b/docs/vision/detect.md @@ -0,0 +1,8 @@ +--- +linkTitle: "detect" +title: "detect" +weight: 10 +layout: "docs" +type: "docs" +description: "detect." +--- diff --git a/docs/vision/measure-depth.md b/docs/vision/measure-depth.md new file mode 100644 index 0000000000..883dd028e5 --- /dev/null +++ b/docs/vision/measure-depth.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Measure Depth" +title: "Measure Depth" +weight: 50 +layout: "docs" +type: "docs" +description: "Retrieve point clouds and depth images from a depth camera, read depth at specific pixels, and measure distance to detected objects." +date: "2025-01-30" +--- diff --git a/docs/vision/track.md b/docs/vision/track.md new file mode 100644 index 0000000000..6fc1c76474 --- /dev/null +++ b/docs/vision/track.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Track Objects" +title: "Track Objects Across Frames" +weight: 40 +layout: "docs" +type: "docs" +description: "Match detections across consecutive frames using IoU, assign stable track IDs, and count entries and exits." +date: "2025-01-30" +--- diff --git a/docs/what-is-viam/_index.md b/docs/what-is-viam/_index.md new file mode 100644 index 0000000000..42de7a11d8 --- /dev/null +++ b/docs/what-is-viam/_index.md @@ -0,0 +1,12 @@ +--- +linkTitle: "What is Viam?" +title: "What is Viam?" +weight: 10 +layout: "docs" +type: "docs" +no_list: true +images: ["/general/understand.png"] +imageAlt: "Viam platform overview" +description: "Viam is a software platform for building, deploying, and managing robotics applications." +date: "2025-01-30" +--- diff --git a/docs/what-is-viam/problems-viam-solves.md b/docs/what-is-viam/problems-viam-solves.md new file mode 100644 index 0000000000..eaf762a91f --- /dev/null +++ b/docs/what-is-viam/problems-viam-solves.md @@ -0,0 +1,9 @@ +--- +linkTitle: "Problems Viam Solves" +title: "Problems Viam Solves" +weight: 20 +layout: "docs" +type: "docs" +description: "A guide to the challenges you'll face at each stage of robotics development and how Viam helps." +date: "2025-01-30" +--- diff --git a/docs/what-is-viam/what-is-viam.md b/docs/what-is-viam/what-is-viam.md new file mode 100644 index 0000000000..7bf2bd540e --- /dev/null +++ b/docs/what-is-viam/what-is-viam.md @@ -0,0 +1,11 @@ +--- +linkTitle: "What is Viam?" +title: "What is Viam?" +weight: 1 +layout: "docs" +type: "docs" +description: "Viam is a software platform for building, deploying, and managing robotics applications." +images: ["/general/understand.png"] +imageAlt: "Viam platform overview" +date: "2025-01-30" +--- diff --git a/layouts/partials/navbar.html b/layouts/partials/navbar.html index ecdf1b06a1..6e382a6855 100644 --- a/layouts/partials/navbar.html +++ b/layouts/partials/navbar.html @@ -74,17 +74,4 @@ -
-
    -
  • Overview
    • - {{ with .Site.GetPage "/" }} - {{- range .Pages -}} - {{- $activePath := or ($currentPage.IsDescendant .) (eq $currentPage .) -}} - {{- if not (eq .LinkTitle "Tutorials") -}} -
  • {{ .LinkTitle }}
    • - {{- end -}} - {{- end -}} - {{- end -}} -
-
diff --git a/layouts/partials/sidebar-tree.html b/layouts/partials/sidebar-tree.html index bf5c14999a..8e98bc545d 100644 --- a/layouts/partials/sidebar-tree.html +++ b/layouts/partials/sidebar-tree.html @@ -64,7 +64,7 @@ {{ else }} {{ if or ( or (not $toc_hide) ($activePath) ) $active }} -
  • +
  • {{ if (and $p.Site.Params.ui.sidebar_menu_foldable (ge $ulNr 1)) -}}