Skip to content
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

Update controls-package.md #3508

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update controls-package.md #3508

wants to merge 1 commit into from

Conversation

npentrel
Copy link
Collaborator

@randhid do you think this is used for anything or should we delete this?

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 26, 2024
@viambot
Copy link
Member

viambot commented Sep 26, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3508

@randhid
Copy link
Member

randhid commented Sep 26, 2024

@randhid do you think this is used for anything or should we delete this?

It is used in all our controlled components, and if you want to configure a loop in a go module to use our control logic, this shows you how. Is internals getting a face-lift, is that why we're converting it to draft?

If so, we can add it as a link to the components' pages, I did want to link to this page in the readme when we modularize the controlled components, which will happen in the next 4-5 weeks.

@stevebriskin
Copy link
Member

@randhid I told Naomi that this info is extremely internal and no one external would use it. Sounds like you disagree, which is fine.
Maybe we need a place where we document utilities like this (along with goutils type stuff). Or integrate it more natively into component config docs. "Viam Internals" isn't the right place for this if we expect people to use it.

@randhid
Copy link
Member

randhid commented Sep 26, 2024

@randhid I told Naomi that this info is extremely internal and no one external would use it. Sounds like you disagree, which is fine. Maybe we need a place where we document utilities like this (along with goutils type stuff). Or integrate it more natively into component config docs. "Viam Internals" isn't the right place for this if we expect people to use it.

I see. We can put it under motor and base same as we have "calibrate a camera" under camera, "cbirrt and tp-space" under motion, and "set up an rtk base" under movement sensor. It's in the same bucket as those things - which are specific ways of making some models of that api type work and are also libraries in some way (rimage, motionplan, gpsutils)

@npentrel npentrel marked this pull request as draft September 28, 2024 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants