Skip to content

DOCS-2881: Revamp Micro-RDK docs #4241

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.

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

Merged
merged 30 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
862b9d5
Start tweaking
JessamyT Apr 17, 2025
9cb05ce
Move dev setup and build instructions to set up esp32
JessamyT Apr 18, 2025
259dec4
Move content to the micro reference page and change its title
JessamyT Apr 18, 2025
afdfc70
Add config section
JessamyT Apr 18, 2025
5bb8901
Move troubleshooting and management content
JessamyT Apr 19, 2025
5b52325
Add module details
JessamyT Apr 22, 2025
6e73118
Working random number sensor
JessamyT Apr 22, 2025
df5e8ec
Add dependencies details, update links
JessamyT Apr 23, 2025
1420e45
Move details note
JessamyT Apr 23, 2025
03a98e2
Add cloud build instructions, move OTA from manage and draft mode it,…
JessamyT Apr 23, 2025
0725075
Add permissions step
JessamyT Apr 24, 2025
c1b54e1
cachekey
JessamyT Apr 24, 2025
352416e
Remove make upload
JessamyT Apr 24, 2025
a193a9d
Add prereq, fix links
JessamyT Apr 24, 2025
3645c34
Fix more links and link descriptions
JessamyT Apr 24, 2025
b943ff3
Apply suggestions from code review
JessamyT Apr 24, 2025
bf5deb9
Delete manage-micro page
JessamyT Apr 24, 2025
5266826
Move troubleshooting section
JessamyT Apr 24, 2025
baf8cd4
Reorganize and clarify OTA and cloud build a bit
JessamyT Apr 25, 2025
4f4cab0
Fix links, tweak cloud build steps
JessamyT Apr 25, 2025
d152572
Shorten use your module
JessamyT Apr 25, 2025
052cc72
Tweak http line order
JessamyT Apr 25, 2025
44667bc
Remove secret snippet per feedback
JessamyT Apr 25, 2025
8105aa5
fix nit
JessamyT Apr 25, 2025
1a2b742
Update docs/operate/get-started/other-hardware/micro-module.md
JessamyT Apr 25, 2025
82012ae
Apply suggestions from code review
JessamyT Apr 25, 2025
f64f6d1
Apply suggestions from code review
JessamyT Apr 25, 2025
0a0373a
Fix nit
JessamyT Apr 25, 2025
827bfae
Apply suggestions from code review
JessamyT Apr 25, 2025
293c6a6
Apply Esha cloud steps feedback
JessamyT Apr 25, 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
Binary file added assets/get-started/micro-credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/dev/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ You can now [authenticate end users with OAuth](/manage/manage/oauth/).

{{% changelog color="added" title="Over-the-air updates for the Micro-RDK" date="2025-01-08" %}}

You can now update microcontroller firmware from anywhere using the [OTA update service](/operate/get-started/other-hardware/micro-module/#over-the-air-updates).
You can now update microcontroller firmware from anywhere using the [OTA update service](/operate/get-started/setup-micro/#configure-over-the-air-updates).

{{% /changelog %}}

Expand Down
2 changes: 1 addition & 1 deletion docs/manage/software/control-logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ These are the same modules that provide functionality like drivers and integrati

The following steps show you how to create modules with control logic and how to deploy them to individual machines using `viam-server`.

For microcontrollers, see [Micro-RDK modules](/operate/get-started/other-hardware/micro-module/) and [Over-the-air firmware updates](/operate/get-started/other-hardware/micro-module/#over-the-air-updates) instead.
For microcontrollers, see [Micro-RDK modules](/operate/get-started/other-hardware/micro-module/) and [Over-the-air firmware updates](/operate/get-started/setup-micro/#configure-over-the-air-updates) instead.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs/manage/software/deploy-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ cost: "0"

The following steps show you how to deploy and manage your machine's software over the air (OTA).

For microcontrollers, see [Over-the-air firmware updates](/operate/get-started/other-hardware/micro-module/#over-the-air-updates) for more information.
For microcontrollers, see [Over-the-air firmware updates](/operate/get-started/setup-micro/#configure-over-the-air-updates) for more information.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs/manage/software/update-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Each deployed {{< glossary_tooltip term_id="module" text="module" >}} or {{< glo
Unless the `version` field is set to a specific version, updates for that module or package happen automatically.

{{% alert title="Updates for microcontrollers" color="note" %}}
To update the firmware on your microcontroller, see [Over-the-air updates](/operate/get-started/other-hardware/micro-module/#over-the-air-updates).
To update the firmware on your microcontroller, see [Over-the-air updates](/operate/get-started/setup-micro/#configure-over-the-air-updates).
{{% /alert %}}

## Test and update software
Expand Down
383 changes: 71 additions & 312 deletions docs/operate/get-started/other-hardware/micro-module.md

Large diffs are not rendered by default.

70 changes: 0 additions & 70 deletions docs/operate/get-started/setup-micro.md

This file was deleted.

Loading
Loading