search

nimbella / docs

Apache License 2.0
3 stars 9 forks source link

Organization and auto-gen improvements to command doc #12

Closed joshuaauerbachwatson closed 3 years ago

joshuaauerbachwatson commented 3 years ago

This PR covers an organization change and a step in the direction of further automation for the detailed nim command documentation. The current organization is support by a script in nimbella-cli (public). With a few exceptions, the documents being committed here are auto-generated and incomplete (they don't have the human-provided text yet).

joshuaauerbachwatson commented 3 years ago

Will the auto generation be documented?

Yes it should be documented but

  1. I'm not sure where the documentation should go
  2. I'd prefer to wait anyway until the process of absorbing changes and integrating the automated and non-automated steps is better worked out.
joshuaauerbachwatson commented 3 years ago

I'm going to merge this so that I can rebase it into another open PR. The documentation being merged is skeletal in places but it replaces a more monolithic document that was equally skeletal and there are certainly many other empty or incomplete documents.