From 2e101361027b4be6ae7da0145735876fd77c146a Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Fri, 17 Jan 2025 09:16:52 -0800 Subject: [PATCH] Add micro-RDK style guide suggestion (#3861) --- .github/vale/styles/Viam/AvoidWithSubstitution.yml | 1 + .../styles/Viam/AvoidWithSubstitutionViamCaseSensitive.yml | 1 + docs/dev/reference/changelog.md | 2 +- docs/dev/reference/glossary/viam-micro-server.md | 2 +- docs/operate/get-started/other-hardware/micro-module.md | 2 +- docs/operate/get-started/supported-hardware/_index.md | 2 +- docs/operate/reference/components/camera/esp32-camera.md | 4 ++-- docs/operate/reference/components/camera/fake-micro-server.md | 2 +- docs/operate/reference/viam-micro-server/_index.md | 4 ++-- 9 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/vale/styles/Viam/AvoidWithSubstitution.yml b/.github/vale/styles/Viam/AvoidWithSubstitution.yml index a4cc7273ff..fb6e16515c 100644 --- a/.github/vale/styles/Viam/AvoidWithSubstitution.yml +++ b/.github/vale/styles/Viam/AvoidWithSubstitution.yml @@ -86,6 +86,7 @@ swap: make sure: ensure matrices: matrixes meta-data: metadata + microRDK: Micro-RDK name space: namespace nameserver: name server need to: must diff --git a/.github/vale/styles/Viam/AvoidWithSubstitutionViamCaseSensitive.yml b/.github/vale/styles/Viam/AvoidWithSubstitutionViamCaseSensitive.yml index 69b85ac07d..fee3ab0cd5 100644 --- a/.github/vale/styles/Viam/AvoidWithSubstitutionViamCaseSensitive.yml +++ b/.github/vale/styles/Viam/AvoidWithSubstitutionViamCaseSensitive.yml @@ -22,6 +22,7 @@ swap: Viam-server: viam-server Viam server: viam-server Viam-Server: viam-server + micro-RDK: Micro-RDK Config Tab: CONFIG tab Config tab: CONFIG tab Vision service: vision service diff --git a/docs/dev/reference/changelog.md b/docs/dev/reference/changelog.md index beeb59fb13..77fcf61bcf 100644 --- a/docs/dev/reference/changelog.md +++ b/docs/dev/reference/changelog.md @@ -113,7 +113,7 @@ For more information, see [Configure an esp32-camera](/operate/reference/compone {{% changelog date="2024-08-26" color="changed" title="Micro-RDK now called viam-micro-server" %}} -The lightweight version of `viam-server` that is built from the micro-RDK is now referred to as `viam-micro-server`. +The lightweight version of `viam-server` that is built from the Micro-RDK is now referred to as `viam-micro-server`. For more information, see [viam-micro-server](/operate/reference/viam-micro-server/). {{% /changelog %}} diff --git a/docs/dev/reference/glossary/viam-micro-server.md b/docs/dev/reference/glossary/viam-micro-server.md index c081e603ce..0e37cf4073 100644 --- a/docs/dev/reference/glossary/viam-micro-server.md +++ b/docs/dev/reference/glossary/viam-micro-server.md @@ -7,6 +7,6 @@ short_description: The lightweight version of viam-server that can run on ESP32 The lightweight version of `viam-server`, built for microcontrollers. `viam-micro-server` is a set of open-source utilities which run on your microcontroller and provides Viam functionality to your machine. -`viam-micro-server` is built from the micro-RDK. +`viam-micro-server` is built from the Micro-RDK. For more information see [Architecture](/operate/reference/viam-micro-server/). diff --git a/docs/operate/get-started/other-hardware/micro-module.md b/docs/operate/get-started/other-hardware/micro-module.md index f499a65727..4360b41d05 100644 --- a/docs/operate/get-started/other-hardware/micro-module.md +++ b/docs/operate/get-started/other-hardware/micro-module.md @@ -37,7 +37,7 @@ The instructions below are for configuring a development environment in order to ## Required software -The [micro-RDK](https://github.com/viamrobotics/micro-rdk) (from which `viam-micro-server` is built) is written in Rust. +The [Micro-RDK](https://github.com/viamrobotics/micro-rdk) (from which `viam-micro-server` is built) is written in Rust. To be able to develop for `viam-micro-server` on macOS and Linux systems, you must install the following software on your development machine: 1. Install dependencies: diff --git a/docs/operate/get-started/supported-hardware/_index.md b/docs/operate/get-started/supported-hardware/_index.md index 03f7fd60e8..59beab39bd 100644 --- a/docs/operate/get-started/supported-hardware/_index.md +++ b/docs/operate/get-started/supported-hardware/_index.md @@ -144,4 +144,4 @@ Modules for 64-bit architecture run alongside [`viam-server`](/operate/reference When a module initializes, it registers its {{< glossary_tooltip term_id="model" text="model or models" >}} and associated [APIs](/dev/reference/apis/) with `viam-server`, making the new model available for use. `viam-server` manages the [dependencies](/operate/reference/viam-server/#dependency-management), [start-up](/operate/reference/viam-server/#start-up), [reconfiguration](/operate/reference/viam-server/#reconfiguration), [data management](/data-ai/capture-data/capture-sync/), and [shutdown](/operate/reference/viam-server/#shutdown) behavior of your modular resource. -For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the micro-RDK and one or more modules onto your device. +For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the Micro-RDK and one or more modules onto your device. diff --git a/docs/operate/reference/components/camera/esp32-camera.md b/docs/operate/reference/components/camera/esp32-camera.md index 1b7169c346..d123d98e85 100644 --- a/docs/operate/reference/components/camera/esp32-camera.md +++ b/docs/operate/reference/components/camera/esp32-camera.md @@ -5,7 +5,7 @@ weight: 33 type: "docs" description: "Configure a camera connected to an esp32 board, initialized and configured using esp-idf." images: ["/icons/components/camera.svg"] -tags: ["camera", "components", "micro-RDK"] +tags: ["camera", "components", "Micro-RDK"] component_description: "An `OV2640` or `OV3660` camera connected to an esp32 board." micrordk_component: true toc_hide: true @@ -13,7 +13,7 @@ date: "2024-08-28" aliases: - /components/camera/esp32-camera/ # updated: "" # When the content was last entirely checked -# SMEs: Matt Perez, micro-RDK team +# SMEs: Matt Perez, Micro-RDK team --- `esp32-camera` is the camera model that supports all cameras that work with Espressif's [esp32-camera drivers](https://github.com/espressif/esp32-camera) including: diff --git a/docs/operate/reference/components/camera/fake-micro-server.md b/docs/operate/reference/components/camera/fake-micro-server.md index 22bdaa2360..9584f317b3 100644 --- a/docs/operate/reference/components/camera/fake-micro-server.md +++ b/docs/operate/reference/components/camera/fake-micro-server.md @@ -11,7 +11,7 @@ aliases: component_description: "A camera model for testing." micrordk_component: true toc_hide: true -# SMEs: Matt Perez, micro-RDK team +# SMEs: Matt Perez, Micro-RDK team --- A `fake` camera is a camera model for testing. diff --git a/docs/operate/reference/viam-micro-server/_index.md b/docs/operate/reference/viam-micro-server/_index.md index d729d3996c..5b53a76a8b 100644 --- a/docs/operate/reference/viam-micro-server/_index.md +++ b/docs/operate/reference/viam-micro-server/_index.md @@ -12,7 +12,7 @@ date: "2024-09-03" --- `viam-micro-server` is the lightweight version of [`viam-server`](/operate/reference/viam-server/) which can run on resource-limited embedded systems (ESP32) that cannot run the fully-featured `viam-server`. -`viam-micro-server` is built from the open-source [micro-RDK](https://github.com/viamrobotics/micro-rdk/). +`viam-micro-server` is built from the open-source [Micro-RDK](https://github.com/viamrobotics/micro-rdk/). ## Hardware requirements @@ -20,7 +20,7 @@ date: "2024-09-03" ## Support -[Client API](/dev/reference/apis/) usage with the micro-RDK currently supports the following {{< glossary_tooltip term_id="resource" text="resources" >}}: +[Client API](/dev/reference/apis/) usage with the Micro-RDK currently supports the following {{< glossary_tooltip term_id="resource" text="resources" >}}: {{< cards >}} {{% relatedcard link="/dev/reference/apis/components/base/" %}}