-
Notifications
You must be signed in to change notification settings - Fork 43
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
Add missing viam module create
step in hello world module docs
#3744
Conversation
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3744 |
Hey @Abalaxy I see there is |
In my exploring I also saw there were two similar how-tos for creating a module. Should there be only one? |
My understanding is that using
These two docs serve two different purposes: The hello world guide is more prescriptive and provides less information. It's also only for Python and Go. The more general create a module guide provides more details and generalized guidance, and includes C++ information. Currently, there's also the Create a Python Sensor Module guide, which has overlap as well. The docs IA is changing, and with those changes we'll be modifying some of this content. |
Aggghhh, I missed switching that to |
I’m sorry! I’m realizing the instructions to set it to Yes may have been updated only after you first encountered this page, because I did indeed erroneously have it set to No in a previous version. You were actually onto something before my other PR merged. Thank you so much for your efforts in any case. |
No worries at all! Now I know how to make changes to the docs, so it was a useful exercise! |
Was going through the Create a Hello World module doc and discovered that the
viam module create
step was missing, but that it was present in the dedicated Upload a module to the Viam Registry doc. Added in that information, for both Python and Go, and updated the language in the existing steps to be consistent with the change.Screenshots:
Python
Go