APP-7171: Add README.md to module generate CLI #4731
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generates a base README.md for modules created with
viam module generate
. The template is inspired by our docs readme example. Meta.json is updated to have a relative link to the model level documentation of the readme. I adjusted the template with this feature in mind, attempting to reduce repetitive sentences "to configure a component/service go to..." and "This is a model that implements the ... API" so that the docs embedded in the app are to the point.Tested the generator locally:
go run cli/viam/main.go module generate
Selected: "my-module-4", "test" namespace, Python, Arm Component, "my-model-4", Use CloudBuild, Register with Viam.
Generated markdown:
Generated meta.json: