Skip to content

Commit c9ace09

Browse files
npentrelnpentrel
committed
Draft
1 parent 7156694 commit c9ace09

File tree

5 files changed

+113
-173
lines changed

5 files changed

+113
-173
lines changed

‎docs/_index.md

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -27,68 +27,38 @@ aliases:
2727
- "/platform/"
2828
---
2929

30-
<div class="max-page">
31-
<div class="hero-container">
32-
<div class="hero-text">
33-
<h1>Viam Documentation</h1>
34-
<p>
35-
Viam integrates with hardware and software on <b>any device</b> in the physical world. Once you <a href="/operate/get-started/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 add use machine learning, data management, and much more for your projects.
36-
</p>
37-
<div class="cards max-page">
38-
<div class="front-card-container">
39-
<div class="hover-card primary">
40-
<a href="/operate/get-started/setup/" class="noanchor">
41-
<div>
42-
<p>Get started</p>
43-
</div>
44-
</a>
45-
</div>
46-
<div class="cta secondary">
47-
<a href="/dev/" class="noanchor"><div>
48-
<p>APIs & CLI →</p></div>
49-
</a>
50-
</div>
51-
</div>
52-
</div>
53-
</div>
54-
<img src="docs-hero-image.png" alt="App illustration" class="hero">
55-
</div>
56-
</div>
57-
<br>
58-
5930
<!-- Need to use upside down logic because using Subsequent-sibling combinator -->
6031
<div class="max-page gray-container">
61-
<h2 id="platform">The Viam platform
32+
<h2 id="platform">Viam Documentation
6233
<div class="copied" id="copied-platform" aria-hidden="true">
6334
<div class="copied-notification" id="copied-platform-text"></div>
6435
</div>
6536
</h2>
66-
<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>
37+
<p> Viam is a software platform for devices that interact with the physical world.</p>
6738
<br>
68-
<div class="imgcontcenter">
69-
<div class="img-overlay-wrap aligncenter">
70-
<img src="platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
71-
<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" >
72-
<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" >
73-
<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" >
74-
</div>
75-
</div>
7639

77-
<br>
40+
- [**`viam-server` →**](/operate/reference/viam-server/)
7841

79-
<div class="three-cards hoveraction">
42+
The open-source server that runs on machines to manage hardware and software.
8043

81-
<div class="col hover-card build-platform">
82-
<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>
83-
</div>
44+
- [**Viam →**](https://app.viam.com/robots)
8445

85-
<div class="col hover-card data-platform">
86-
<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>
87-
</div>
46+
The cloud app for configuration and management.
8847

89-
<div class="col hover-card fleet-platform">
90-
<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>
91-
</div>
48+
- [**Architectural Overview →**](/operate/reference/architecture/)
49+
50+
How a machine is structured, including on-device and cloud communications.
51+
52+
- [**Building machines →**](/operate/)
53+
54+
Mix and match from existing software resources or make your own.
55+
56+
- [**Data management & AI →**](/data-ai/)
57+
58+
Manage data from your devices and use it with machine learning.
59+
60+
- [**Fleet Management →**](/manage/)
61+
62+
Remotely deploy and manage software on any fleet of devices.
9263

93-
</div>
9464
</div>

‎docs/data-ai/_index.md

Lines changed: 19 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
linkTitle: "AI and Data"
3-
title: "Work with Data and AI"
3+
title: "AI and Data"
44
weight: 250
55
layout: "docs"
66
type: "docs"
@@ -12,54 +12,28 @@ notoc: true
1212
description: "Sync and store sensor data, images, and any other binary or timeseries data. Then use ML and AI to turn your data into insights and action."
1313
---
1414

15-
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.
16-
Then, you can act or alert on inferences.
17-
You can also monitor your machines through teleop, power your application logic, or analyze historical data trends.
15+
<div class="max-page gray-container">
16+
<p> Manage data from your devices and use it with machine learning.</p>
17+
<br>
1818

19-
<div class="img-overlay-wrap aligncenter">
20-
<img src="../platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto">
21-
<img src="../platform/platform-data-capture.svg" alt="Platform diagram with data capture elements highlighted" class="aligncenter overlay" id="data-platform-capture" style="width:800px;height:auto" loading="lazy" >
22-
<img src="../platform/platform-data-work.svg" alt="Platform diagram with data usage elements highlighted" class="aligncenter overlay" id="data-platform-work" style="width:800px;height:auto" loading="lazy" >
23-
<img src="../platform/platform-data-ai.svg" alt="Platform diagram with AI elements highlighted" class="aligncenter overlay" id="data-platform-ai" style="width:800px;height:auto" loading="lazy" >
24-
</div>
19+
- [**Data Management →**](/data-ai/capture-data/capture-sync/)
2520

26-
<div class="hoveraction">
21+
Capture and sync data from devices.
2722

28-
{{< how-to-expand "Capture data" "4" "BEGINNER-FRIENDLY" "" "data-platform-capture" >}}
29-
{{< cards >}}
30-
{{% card link="/data-ai/capture-data/capture-sync/" noimage="true" %}}
31-
{{% card link="/data-ai/capture-data/filter-before-sync/" noimage="true" %}}
32-
{{% card link="/data-ai/capture-data/conditional-sync/" noimage="true" %}}
33-
{{% card link="/data-ai/capture-data/lorawan/" noimage="true" %}}
34-
{{< /cards >}}
35-
{{< /how-to-expand >}}
23+
- [**Machine Learning →**](/data-ai/train/train-tflite/)
3624

37-
{{< how-to-expand "Work with data" "4" "BEGINNER-FRIENDLY" "" "data-platform-work" >}}
38-
{{< cards >}}
39-
{{% card link="/data-ai/data/query/" noimage="true" %}}
40-
{{% card link="/data-ai/data/visualize/" noimage="true" %}}
41-
{{% card link="/data-ai/data/advanced/alert-data/" noimage="true" %}}
42-
{{% card link="/data-ai/data/export/" noimage="true" %}}
43-
{{< /cards >}}
44-
{{< /how-to-expand >}}
25+
Build a dataset to train machine learning models for your machines.
4526

46-
{{< how-to-expand "Train an ML model" "5" "INTERMEDIATE" "" "data-platform-ai" >}}
47-
{{< cards >}}
48-
{{% card link="/data-ai/train/create-dataset/" noimage="true" %}}
49-
{{% card link="/data-ai/train/capture-annotate-images/" noimage="true" %}}
50-
{{% card link="/data-ai/train/train-tflite/" noimage="true" %}}
51-
{{% card link="/data-ai/train/train/" noimage="true" %}}
52-
{{% card link="/data-ai/train/upload-external-data/" noimage="true" %}}
53-
{{< /cards >}}
54-
{{< /how-to-expand >}}
27+
- [**Computer Vision →**](/data-ai/ai/run-inference/)
5528

56-
{{< how-to-expand "Infer with ML models" "4" "INTERMEDIATE" "" "data-platform-ai" >}}
57-
{{< cards >}}
58-
{{% card link="/data-ai/ai/deploy/" noimage="true" %}}
59-
{{% card link="/data-ai/ai/run-inference/" noimage="true" %}}
60-
{{% card link="/data-ai/ai/alert/" noimage="true" %}}
61-
{{% card link="/data-ai/ai/act/" noimage="true" %}}
62-
{{< /cards >}}
63-
{{< /how-to-expand >}}
29+
Allow machines to interpret their environments.
6430

65-
</div>
31+
- [**Query data →**](/data-ai/data/query/)
32+
33+
Graph or query data from all your devices.
34+
35+
- [**LoRaWAN networks →**](/data-ai/capture-data/lorawan/)
36+
37+
Collect LoRaWAN sensor data with Viam.
38+
39+
</div>

‎docs/dev/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,28 @@ aliases:
1616
- /internals/
1717
---
1818

19+
<div class="max-page gray-container">
20+
<p> Remotely deploy and manage software on any fleet of devices - from anywhere.</p>
21+
<br>
22+
23+
- [**CLI →**](/dev/tools/cli/)
24+
25+
Manage your machines resources from the command line.
26+
27+
- [**Tutorials →**](LINK)
28+
29+
Build small projects while learning new skills.
30+
31+
- [**APIs →**](LINK)
32+
33+
Every Viam resource exposes an API described through protocol buffers.
34+
35+
- [**SDKs →**](/dev/reference/sdks/)
36+
37+
Control your machines with Go, Python, TypeScript, Flutter, C++, and more..
38+
39+
</div>
40+
1941
<div class="max-page">
2042
<div class="hero-container-small">
2143
<div class="hero-text">

‎docs/manage/_index.md

Lines changed: 21 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -17,51 +17,32 @@ aliases:
1717
- /product-overviews/fleet-management/
1818
---
1919

20-
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.
20+
<div class="max-page gray-container">
21+
<p> Remotely deploy and manage software on any fleet of devices - from anywhere.</p>
22+
<br>
2123

22-
<div class="img-overlay-wrap aligncenter">
23-
<img src="../platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
24-
<img src="../platform/platform-fleet-team.svg" alt="Platform diagram with team management elements highlighted" id="fleet-platform-team" class="aligncenter overlay" style="width:800px;height:auto" loading="lazy">
25-
<img src="../platform/platform-fleet-management.svg" alt="Platform diagram with deploy and manage elements highlighted" class="aligncenter overlay" id="fleet-platform-management" style="width:800px;height:auto" loading="lazy" >
26-
<img src="../platform/platform-fleet-monitor.svg" alt="Platform diagram with monitoring elements highlighted" class="aligncenter overlay" id="fleet-platform-monitor" style="width:800px;height:auto" loading="lazy" >
27-
</div>
24+
- [**Fleet Management →**](/manage/fleet/reuse-configuration/)
25+
26+
Set up all your machines with shared configuration fragments.
27+
28+
- [**Provisioning →**](/manage/fleet/provision/setup/)
29+
30+
Set up machines with a pre-defined configuration as they come online.
31+
32+
- [**Monitoring →**](/manage/troubleshoot/monitor/)
33+
34+
Remotely monitor and operate all your machines.
35+
36+
- [**Access Control →**](manage/manage/access/)
2837

29-
<div class="hoveraction">
38+
Collaborate with others on your machines.
3039

31-
{{< how-to-expand "Deploy a fleet of machines" "4" "INTERMEDIATE" "" "fleet-platform-management">}}
32-
{{< cards >}}
33-
{{% card link="/manage/fleet/reuse-configuration/" noimage="true" %}}
34-
{{% card link="/manage/fleet/system-settings/" noimage="true" %}}
35-
{{% card link="/manage/fleet/provision/setup/" noimage="true" %}}
36-
{{% card link="manage/fleet/provision/end-user-setup/" noimage="true" %}}
37-
{{< /cards >}}
38-
{{< /how-to-expand >}}
40+
- [**Maintenance and Updates →**](/manage/software/update-software/)
3941

40-
{{< how-to-expand "Deploy code and manage software on machines" "2" "INTERMEDIATE" "fleet-platform-management" >}}
41-
{{< cards >}}
42-
{{% card link="/manage/software/control-logic/" noimage="true" %}}
43-
{{% card link="/manage/software/deploy-software/" noimage="true" %}}
44-
{{% card link="/manage/software/update-software/" noimage="true" %}}
45-
{{< /cards >}}
46-
{{< /how-to-expand >}}
42+
Roll out software updates to your machines in a few clicks.
4743

48-
{{< how-to-expand "Manage access for organizations" "4" "INTERMEDIATE" "" "fleet-platform-team" >}}
49-
{{< cards >}}
50-
{{% card link="/manage/manage/access/" noimage="true" %}}
51-
{{% card link="/manage/manage/rbac/" noimage="true" %}}
52-
{{% card link="/manage/manage/oauth/" noimage="true" %}}
53-
{{% card link="/manage/manage/white-labelled-billing/" noimage="true" %}}
54-
{{< /cards >}}
55-
{{< /how-to-expand >}}
44+
- [**OS settings & Networking →**](/manage/fleet/system-settings/)
5645

57-
{{< how-to-expand "Remotely monitor and troubleshoot" "5" "INTERMEDIATE" "" "fleet-platform-monitor" >}}
58-
{{< cards >}}
59-
{{% card link="/manage/troubleshoot/monitor/" noimage="true" %}}
60-
{{% card link="/manage/troubleshoot/alert/" noimage="true" %}}
61-
{{% card link="/manage/troubleshoot/teleoperate/custom-interface" customTitle="Teleoperate with custom interface" noimage="true" %}}
62-
{{% card link="/manage/troubleshoot/teleoperate/default-interface" customTitle="Teleoperate with default interface" noimage="true" %}}
63-
{{% card link="/manage/troubleshoot/troubleshoot/" noimage="true" %}}
64-
{{< /cards >}}
65-
{{< /how-to-expand >}}
46+
Configure networks and package updates for the host operating system.
6647

6748
</div>

‎docs/operate/_index.md

Lines changed: 30 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,43 +14,36 @@ aliases:
1414
- /build/
1515
---
1616

17-
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.
18-
19-
<!-- Need to use upside down logic because using Subsequent-sibling combinator -->
20-
<div class="img-overlay-wrap aligncenter">
21-
<img src="../platform/platform-all.svg" alt="Platform diagram" id="fleet-platform-all" class="aligncenter overview" style="width:800px;height:auto" >
22-
<img src="../platform/platform-build-connect.svg" alt="Platform diagram with connect elements highlighted" class="aligncenter overlay" id="build-platform-connect" style="width:800px;height:auto" loading="lazy" >
23-
<img src="../platform/platform-build-apps.svg" alt="Platform diagram with apps element highlighted" class="aligncenter overlay" id="build-platform-apps" style="width:800px;height:auto" loading="lazy" >
24-
<img src="../platform/platform-build-motion.svg" alt="Platform diagram with motion elements highlighted" class="aligncenter overlay" id="build-platform-motion" style="width:800px;height:auto" loading="lazy" >
25-
</div>
17+
<div class="max-page gray-container">
18+
<p> Control your device and any attached physical hardware from anywhere in the world.</p>
19+
<br>
20+
21+
- [**Installation →**](/operate/get-started/setup/)
22+
23+
Install Viam on any device.
24+
25+
- [**Registry →**](/operate/get-started/supported-hardware/)
26+
27+
An online hub of resources you can use on your machines..
28+
29+
- [**Modules →**](/operate/get-started/other-hardware/create-module/)
30+
31+
Create modules to support your specialized hardware and software.
32+
33+
- [**Viam applications →**](/operate/control/viam-applications/)
34+
35+
Deploy web applications to provide an interface for your machines.
36+
37+
- [**SDKs →**](/dev/reference/sdks/)
38+
39+
Control your machines with Go, Python, TypeScript, Flutter, C++, and more.
40+
41+
- [**Motion planning →**](/operate/mobility/motion-concepts/)
42+
43+
Use built-in motion planning software to move arms, bases, etc.
44+
45+
- [**Micro-RDK →**](/operate/reference/viam-micro-server/)
2646

27-
<div class="hoveraction">
28-
29-
{{< how-to-expand "Connect devices" "4" "BEGINNER-FRIENDLY" "" "build-platform-connect" >}}
30-
{{< cards >}}
31-
{{% card link="/operate/get-started/basics/" noimage="true" %}}
32-
{{% card link="/operate/get-started/setup/" noimage="true" %}}
33-
{{% card link="/operate/get-started/supported-hardware/" noimage="true" %}}
34-
{{% card link="/operate/get-started/other-hardware/" noimage="true" %}}
35-
{{< /cards >}}
36-
{{< /how-to-expand >}}
37-
38-
{{< how-to-expand "Build apps" "4" "BEGINNER-FRIENDLY" "" "build-platform-apps" >}}
39-
{{< cards >}}
40-
{{% card link="/operate/control/viam-applications/" noimage="true" %}}
41-
{{% card link="/operate/control/web-app/" noimage="true" %}}
42-
{{% card link="/operate/control/mobile-app/" noimage="true" %}}
43-
{{% card link="/operate/control/headless-app/" noimage="true" %}}
44-
{{< /cards >}}
45-
{{< /how-to-expand >}}
46-
47-
{{< how-to-expand "Intelligent actuation and motion planning" "4" "INTERMEDIATE" "" "build-platform-motion" >}}
48-
{{< cards >}}
49-
{{% card link="/operate/mobility/motion-concepts/" noimage="true" %}}
50-
{{% card link="/operate/mobility/move-arm/" noimage="true" %}}
51-
{{% card link="/operate/mobility/move-base/" noimage="true" %}}
52-
{{% card link="/operate/mobility/move-gantry/" noimage="true" %}}
53-
{{< /cards >}}
54-
{{< /how-to-expand >}}
47+
The lightweight version of `viam-server` for microcontrollers.
5548

5649
</div>

0 commit comments

Comments
 (0)