Skip to content

DOCS-4050: Add module configuration details #4375

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 3 commits into from
Jun 3, 2025
Merged

DOCS-4050: Add module configuration details #4375

merged 3 commits into from
Jun 3, 2025

Conversation

JessamyT
Copy link
Collaborator

@JessamyT JessamyT commented Jun 3, 2025

No description provided.

@netlify Netlify
Copy link

netlify bot commented Jun 3, 2025 •
edited
Loading

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 179f38a
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/683f6683e3820000085f3e52
😎 Deploy Preview https://deploy-preview-4375--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: 54 (🟢 up 13 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 project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jun 3, 2025
npentrel
npentrel approved these changes Jun 3, 2025
View reviewed changes
docs/operate/reference/module-configuration.md Outdated
@@ -106,14 +106,20 @@ Examples:
"type": "registry",
"name": "viam_tflite_cpu",
"module_id": "viam:tflite_cpu",
"version": "latest"
"version": "latest",
"disabled": true
Copy link
Collaborator

Choose a reason for hiding this comment

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

This strikes me as not a great example. If someone were to copy this it would be disabled...
Maybe false would be better? Shows the option but it's then usable?

Copy link
Collaborator Author

@JessamyT JessamyT Jun 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Since false is the default, there'd be no reason to use the attribute in the "true" case. The other 3 modules in this example block are enabled so I think it makes sense to do it this way to demonstrate the optionality.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Since you approved I'll take it this is up to my discretion? Going to fix the merge conflicts and then merge

@JessamyT JessamyT merged commit d73ac90 into viamrobotics:main Jun 3, 2025
12 checks passed
@JessamyT JessamyT deleted the 4050local branch June 3, 2025 21:22
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 3, 2025

🔎💬 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

@npentrel npentrel npentrel 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.
3 participants
@JessamyT @npentrel @viambot