diff --git a/docs/build/_index.md b/docs/build/_index.md index 17abeb300b8..f0fe2a8d5eb 100644 --- a/docs/build/_index.md +++ b/docs/build/_index.md @@ -16,40 +16,46 @@ Components drive your hardware, and services provide high-level software functio Viam's APIs are standardized across all models of a given component or service. This means you can test and change hardware without changing code. -{{% alert title="Start building" color="tip" %}} +## Step 1: Install -1. To get started, first [install `viam-server`](/get-started/installation/) on your smart machine's computer. - If you are using a microcontroller instead of a 64-bit computer, you can install a [lightweight version of `viam-server`](/build/micro-rdk/). +To get started, first [install `viam-server`](/get-started/installation/) on your smart machine's computer. +If you are using a microcontroller instead of a 64-bit computer, you can install a [lightweight version of `viam-server`](/build/micro-rdk/). +You can install `viam-server` on your personal computer, or on a single-board computer (SBC) such as one of the following: +

-2. Then pull together the Viam resources you want to use by [configuring your smart machine](/build/configure/). +{{< board-carousel >}} -3. Finally, [program your smart machine](/build/program/) with an SDK in your preferred coding language. +## Step 2: Configure -{{% /alert %}} +Select the Viam {{< glossary_tooltip term_id="resource" text="resources" >}} you want to use and integrate them by [configuring your smart machine](/build/configure/).
-

Components:

+

Components:

{{}}
-

Services:

+

Services:

-If a component or service you want to use for your project is not natively supported, see the [modular resource registry](/registry/). +If a component or service you want to use for your project is not natively supported, see whether it is supported as a {{< glossary_tooltip term_id="modular-resource" text="modular resource" >}} in the [registry](/registry/) or build your own modular resource. -## SDKs +## Step 3: Program -Each category of resource has a standardized API that you can access with an SDK (software development kit) in your preferred programming language. +[Program your smart machine](/build/program/) with an SDK in your preferred coding language. + +Each category of {{< glossary_tooltip term_id="resource" text="resource" >}} has a standardized API that you can access with an SDK (software development kit) in your preferred programming language. For example, you can send the same commands to any kind of motor, using any of the following programming languages: {{}} +

+ {{< cards >}} {{% card link="/build/configure/" %}} {{% card link="/build/program/" %}} diff --git a/docs/get-started/_index.md b/docs/get-started/_index.md index 1cf80a715b3..cd02f5a226b 100644 --- a/docs/get-started/_index.md +++ b/docs/get-started/_index.md @@ -7,119 +7,7 @@ layout: "empty" empty_node: true --- -
- - - - -
+{{< board-carousel >}}
diff --git a/docs/get-started/viam.md b/docs/get-started/viam.md index d2c2936ade4..0866d70469d 100644 --- a/docs/get-started/viam.md +++ b/docs/get-started/viam.md @@ -38,6 +38,10 @@ Join the [**Viam community**](https://discord.gg/viam) to collaborate during pla A _smart machine_ in Viam consists of at least one computer, typically a [single-board computer](/get-started/installation/), running `viam-server` and communicating with any hardware connected to it by signaling through digital data pins. Viam supports devices running **any** 64-bit Linux OS or macOS. +Here are some of the boards Viam supports: + +{{< board-carousel >}} +
{{< imgproc src="/viam/board-viam-server.png" alt="A diagram of a single-board computer running viam-server." resize="270x" class="alignleft" style="max-width:270px" >}} diff --git a/docs/platform.md b/docs/platform.md index d6ab1143a91..57151e988f3 100644 --- a/docs/platform.md +++ b/docs/platform.md @@ -8,119 +8,7 @@ type: docs Viam is a complete software platform for {{< glossary_tooltip term_id="smart-machine" text="smart machines">}} that runs on Linux and macOS and supports a wide variety of popular systems, including: -
- - - - -
+{{< board-carousel >}}
Explore the elements of the Viam platform: diff --git a/layouts/partials/scripts.html b/layouts/partials/scripts.html index 77850f730b4..183f1c54b7b 100644 --- a/layouts/partials/scripts.html +++ b/layouts/partials/scripts.html @@ -1,7 +1,7 @@ {{ $jsCarousel := resources.Get "js/carousel.js" }} {{ $jsCarousel := $jsCarousel | minify }} -{{ if or (eq .Page.Title "Viam Documentation") (eq .Page.Title "Platform") }} +{{ if or (eq .Page.Title "Viam Documentation") (eq .Page.Title "Platform") (eq .Page.Title "Viam in 3 minutes") (eq .Page.Title "Build Your Machine with Flexible Building Blocks") (eq .Page.Title "Get Started") }} {{ end }} diff --git a/layouts/shortcodes/board-carousel.html b/layouts/shortcodes/board-carousel.html new file mode 100644 index 00000000000..fc7060d0691 --- /dev/null +++ b/layouts/shortcodes/board-carousel.html @@ -0,0 +1,114 @@ + +
+ + + + +