Skip to content

DOCS-4340: Update landing page #4698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DOCS-4340: Update landing page #4698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be60a51
DOCS-4340: Update landing page
npentrel Oct 8, 2025
68ce0dd
Iterate
npentrel Oct 8, 2025
e9f1cd7
Add builder UI
npentrel Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions assets/scss/_styles_project.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3798,11 +3798,6 @@ footer {
flex-wrap: wrap;
}

.frontpage .col.hover-card {
margin-left: auto !important;
margin-right: auto !important;
}

.copied {
display: inline-block;
margin-left: 2rem;
Expand Down Expand Up @@ -4116,3 +4111,8 @@ footer {
}

/* Feedback System Styles END */

.frontpage .col.hover-card:not(.left):not(.right) {
margin-left: auto !important;
margin-right: auto !important;
}
104 changes: 41 additions & 63 deletions docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
---
title: "Viam Documentation"
linkTitle: "Viam Documentation"
description: "Viam integrates with hardware and software on any device. Use AI, machine learning, and more to make any machine smarter — for one machine to thousands."
description: "Viam adapts software engineering paradigms to building machines for the physical world."
weight: 1
no_list: true
type: "docs"
noToc: true
hide_feedback: true
sitemap:
priority: 1.0
outputs:
Expand All @@ -16,7 +13,7 @@ imageAlt: "/general/understand.png"
images: ["/general/understand.png"]
noedit: true
date: "2024-09-17"
updated: "2024-10-11"
updated: "2025-10-08"
aliases:
- "/getting-started/"
- "/getting-started/high-level-overview"
Expand All @@ -25,70 +22,51 @@ aliases:
- "/viam/app.viam.com/"
- "/get-started/"
- "/platform/"
next: /operate/hello-world/quickstart/
---

<div class="max-page">
<div class="hero-container">
<div class="hero-text">
<h1>Viam Documentation</h1>
<p>
Viam integrates with hardware and software on <b>any device</b> in the physical world. Once you <a href="/operate/install/setup/">set up your machines</a>, you can use Viam SDKs to program your devices and connected hardware. Everything is managed in the cloud and you can use machine learning, data management, and much more for your projects.
</p>
<div class="cards max-page">
<div class="front-card-container">
<div class="hover-card primary">
<a href="/operate/hello-world/quickstart/" class="noanchor">
<div>
<p>Get started</p>
</div>
</a>
</div>
<div class="cta secondary">
<a href="/dev/" class="noanchor"><div>
<p>APIs & CLI →</p></div>
</a>
</div>
</div>
</div>
</div>
<img src="docs-hero-image.png" alt="App illustration" class="hero">
</div>
</div>
<br>
# Viam Documentation

<!-- Need to use upside down logic because using Subsequent-sibling combinator -->
<div class="max-page gray-container">
<h2 id="platform">The Viam platform
<div class="copied" id="copied-platform" aria-hidden="true">
<div class="copied-notification" id="copied-platform-text"></div>
</div>
</h2>
<p> Viam allows you to control and program any sensor, actuator or other hardware that is connected to a device. The Viam platform offers builtin capabilities to capture data from devices to the cloud, to build and deploy machine learning models, to alert on problems, and much more. With the connection to the cloud, you can configure, control, and manage your devices from anywhere.</p>
<br>
<div class="imgcontcenter">
<div class="img-overlay-wrap aligncenter">
<img src="platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
<img src="platform/platform-build-all.svg" alt="Platform diagram with connect elements highlighted" class="aligncenter overlay-platform" id="build-platform" style="width:800px;height:auto" loading="lazy" >
<img src="platform/platform-data-all.svg" alt="Platform diagram with apps element highlighted" class="aligncenter overlay-platform" id="data-platform" style="width:800px;height:auto" loading="lazy" >
<img src="platform/platform-fleet-all.svg" alt="Platform diagram with motion elements highlighted" class="aligncenter overlay-platform" id="fleet-platform" style="width:800px;height:auto" loading="lazy" >
</div>
</div>
Viam adapts software engineering paradigms to building machines for the physical world.

<br>
## Get started with Viam

<div class="three-cards hoveraction">
You can build many types of robotics project on Viam, from single-component projects to human-in-the-loop or AI-powered autonomous intelligent systems.

<div class="col hover-card build-platform">
<div><span><h3>Build & integrate</h3><p>To get started, install Viam on any device and integrate your hardware. Then you can control your device and any attached physical hardware securely from anywhere in the world.</p></span><p><a href="operate/">Learn more</a></p></div>
</div>
- [Hardware agnostic](/operate/hello-world/quickstart/#supported-platforms): Viam runs on almost all single-board computers.
- [Builder UI](/operate/modules/supported-hardware/#configure-hardware-on-your-machine): Configure and test hardware and software with a simple interface.
- [SDKs](/dev/reference/sdks/): Program machines in your favorite programming language.
- [Module Registry](https://app.viam.com/registry): Find and use a variety of integrations for popular hardware, common logic patterns, machine learning models, and more.
- [CLI](/dev/tools/cli/): Control, manage, and test from the command-line from anywhere.

<div class="col hover-card data-platform">
<div><span><h3>Work with Data and AI</h3><p>Viam's data and AI capabilities enable you to capture and sync or upload data, build a dataset, train and deploy ML models, and run inference with computer vision. Then, you can act or alert on inferences.</p></span><p><a href="data-ai/">Learn more</a></p></div>
</div>
We recommend starting with the [Quick Start](/operate/hello-world/quickstart/) and following the [Tutorial: Desk Safari](/operate/hello-world/tutorial-desk-safari/) to build your first machine.

<div class="col hover-card fleet-platform">
<div><span><h3>Deploy, manage, and troubleshoot</h3><p>Viam’s fleet management tooling allows you to remotely deploy and manage software on any fleet of devices. You can monitor all connected devices and troubleshoot any issues - from anywhere.</p></span><p><a href="manage/">Learn more</a></p></div>
</div>
## Build your projects

</div>
</div>
You can use Viam to build entire projects or to add functionality to existing projects.
Before you begin, we recommend reading [How to think about building a machine](/operate/hello-world/building/) to understand the building blocks of a machine and how to go from prototype to production.

- [Modules](/operate/modules/other-hardware/create-module/): The foundational building blocks of machines which keep your machine code maintainable as your project grows in complexity because you can make changes to single modules without changing the rest of the project.
- [Standardized APIs](/dev/reference/apis/): It doesn't matter which robotic arm, motor, or other piece of hardware you are using, the code to operate the hardware is the same. This means you can swap hardware as you iterate.
- [Fragments](/manage/fleet/reuse-configuration/): Reuse configuration chunks across machines. Version control??
- [Parts and sub-parts](/operate/reference/architecture/parts/): Create arbitrarily complex projects by connecting multiple `viam-server` instances.

## Use Viam's platform capabilities

The Viam platform offers many builtin capabilities from which you can pick and choose, such as:

- [Data Management](/data-ai/capture-data/capture-sync/): Capture data from devices to the cloud.
- [Machine learning and Computer Vision](/data-ai/train/create-dataset/): Build and deploy machine learning models.
- [Alerting](/data-ai/ai/alert/): Send alerts in the form of email notifications or webhook requests.
- [Motion Planning](/operate/mobility/motion-concepts/): Smooth and intelligent motion for arms, bases, and gantries.
- [Viam applications](/operate/control/viam-applications/): Deploy custom web interface for your machines while Viam handles hosting and authentication.

## Productionize and scale

When you ship machines, use one or more of the following tools:

- [Provisioning](/manage/fleet/provision/setup/): ship machines with a preconfigured setup so customers can connect them to the internet and get them up and running
- [Role-based access control](/manage/manage/access/): Grant fine-grained permissions as needed.
- [Remote monitoring](/manage/troubleshoot/monitor/): monitor, operate, and troubleshoot machines from anywhere in the world
- [Machine settings](/manage/fleet/system-settings/): manage operating system package updates, network configuration, and system-level logging
- [Billing](/manage/manage/white-labeled-billing/): bill customers for usage through the Viam platform
9 changes: 8 additions & 1 deletion docs/operate/hello-world/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,17 @@ The Viam platform consists of:
- A **registry** of modules for popular hardware and common software needs
- **Cloud-based architecture** for managing machines and controlling configuration updates
- **SDKs** (Python, Go, TypeScript, C++, Flutter)
- **CLI** for managing and operating machines and data from the command line

<div class="imgcontcenter">
<div class="img-overlay-wrap aligncenter">
<img src="/platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
</div>
</div>

## Machines

A machine consists of at least one computer running `viam-server` (often a single-board computer like a Raspberry Pi or Jetson) along with all the hardware components and software services that the computer controls.
A machine consists of at least one computer running `viam-server` (anything from a high-powered rack-mount form-factor to a single-board computer like a Raspberry Pi or Jetson) along with all the hardware and software elements being controlled by that instance of `viam-server`.

When you use Viam to build a machine, you create exactly what you need by mixing and matching different building blocks:

Expand Down
Loading