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.

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

Jump to bottom
Merged
merged 30 commits into from
Apr 25, 2025
Merged

DOCS-2881: Revamp Micro-RDK docs #4241

merged 30 commits into from
Apr 25, 2025

Conversation

JessamyT
Copy link
Collaborator

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Apr 19, 2025
@netlify Netlify
Copy link

netlify bot commented Apr 19, 2025 •
edited
Loading

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 293c6a6
🔍 Latest deploy log https://app.netlify.com/sites/viam-docs/deploys/680c18a9aaae460008314776
😎 Deploy Preview https://deploy-preview-4241--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 43 (🟢 up 4 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@JessamyT JessamyT marked this pull request as ready for review April 24, 2025 18:26
EshaMaharishi
EshaMaharishi reviewed Apr 24, 2025
View reviewed changes
Copy link
Member

@EshaMaharishi EshaMaharishi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! Left a few comments

JessamyT and others added 3 commits April 24, 2025 15:10
@JessamyT JessamyT requested a review from EshaMaharishi April 25, 2025 00:24
EshaMaharishi
EshaMaharishi reviewed Apr 25, 2025
View reviewed changes
docs/operate/get-started/setup-micro.md Outdated
## Build firmware with cloud build

When developing and testing your firmware, it is easiest to build firmware locally.
When you are ready to deploy your firmware to a fleet of microcontrollers, you can use the Viam cloud build service to simplify the process of building and hosting your firmware by eliminating the need to build locally and then upload the firmware image to a cloud storage bucket.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's okay to see how you would configure OTA and then how you would produce a URL - especially because I think we could also make the cloud build instructions shorter, like:

  1. Create a GitHub repository for your firmware project. Note that any modules included in the firmware must point to GitHub repositories (not a local path).
  2. [Current Step 5]
  3. [Current Step 6]

In particular I don't think we should mention any of the credentials stuff (I appreciate you thinking about this though!) because the plan for https://viam.atlassian.net/browse/RSDK-10503 is to stop putting credentials in the firmware build, and instead only providing them at flash time via the micro-rdk-installer.

For including how to build OTA firmware locally - in a way I thought it was nice since it clarifies that OTA supports any URL, not just the one from cloud builds. And I liked the short and simple way you described it.

nathan-contino
nathan-contino approved these changes Apr 25, 2025
View reviewed changes
Copy link
Member

@nathan-contino nathan-contino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, a lot of my comments are optional and/or focused on content that you slightly changed, but didn't originally write.

@JessamyT @nathan-contino @EshaMaharishi
Apply suggestions from code review
82012ae 
Co-authored-by: nate contino <ncontino@u.rochester.edu>
Co-authored-by: Esha Maharishi <esha.maharishi@gmail.com>
JessamyT and others added 2 commits April 25, 2025 13:17
@JessamyT @nathan-contino
Apply suggestions from code review
f64f6d1 
Co-authored-by: nate contino <ncontino@u.rochester.edu>
@JessamyT
Fix nit
0a0373a
EshaMaharishi
EshaMaharishi approved these changes Apr 25, 2025
View reviewed changes
Copy link
Member

@EshaMaharishi EshaMaharishi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm mod comments!

JessamyT and others added 2 commits April 25, 2025 15:38
@JessamyT @nathan-contino
Apply suggestions from code review
827bfae 
Co-authored-by: nate contino <ncontino@u.rochester.edu>
@JessamyT
Apply Esha cloud steps feedback
293c6a6
@viambot
Copy link
Member

viambot commented Apr 25, 2025

It looks like the following files may have been renamed. Please ensure you set all needed aliases:
rename docs/operate/get-started/{setup-micro.md => setup-micro/_index.md} (18%) rename docs/operate/{reference/viam-micro-server => get-started/setup-micro}/micro-troubleshooting.md (58%)

@JessamyT JessamyT merged commit 44cd97f into viamrobotics:main Apr 25, 2025
12 checks passed
@JessamyT JessamyT deleted the 2881micro branch April 25, 2025 23:40
@github-actions GitHub Actions
Copy link

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nathan-contino nathan-contino nathan-contino approved these changes

@EshaMaharishi EshaMaharishi EshaMaharishi approved these changes

Assignees
No one assigned
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@JessamyT @viambot @EshaMaharishi @nathan-contino