We have a pretty basic "API reference" section in the docs that is generated from docstrings and some of our core object class attributes. (which could also use some polish but that's another issue)
We don't have anything similar for our CLI, but the CLI commands do (mostly) have good help text which lives in the function docstrings. We should see if there's an easy way to generate a "CLI reference" page from the same docstrings, analogous to the API reference section.
If there isn't an easy way to do it automatically, we should make a docs page listing every command with at least an example usage for -- users probably won't be aware of certain commands like garden-ai entrypoint add-paper or garden-ai docker prune otherwise
We have a pretty basic "API reference" section in the docs that is generated from docstrings and some of our core object class attributes. (which could also use some polish but that's another issue)
We don't have anything similar for our CLI, but the CLI commands do (mostly) have good help text which lives in the function docstrings. We should see if there's an easy way to generate a "CLI reference" page from the same docstrings, analogous to the API reference section.
If there isn't an easy way to do it automatically, we should make a docs page listing every command with at least an example usage for -- users probably won't be aware of certain commands like
garden-ai entrypoint add-paperorgarden-ai docker pruneotherwise