Rik Smith-Unna
Rik Smith-Unna
If a method overloads something in base, and doesn't have its own docstring, default to showing the documentation for the base method.
We should implement all the recommendations in [this excellent article](https://seirdy.one/posts/2022/06/10/cli-best-practices/). And include tests for them where possible.
`oclif` already allows for including example commands in command classes, and we use these to render the interface documentation. We previously produced some animated recordings of workflows with the CLI...
# Background A set of tools to generate documentation was introduced in #21: - structured JSON CLI interface spec (via [`@labdao/oclif-plugin-helpdata`](https://github.com/labdao/oclif-plugin-helpdata) and `npm run docs:mkjson`) - a README generation script...
Command: `openlab app [appname] --example` e.g. `openlab app alphafold --example` Functionality: output an example job submission config for the named application as YAML
## I confirm: - [x] I've read the [contributing guidelines](https://github.com/aletheia-foundation/aletheia-admin/blob/master/CONTRIBUTING.md) and the [code of conduct](https://github.com/aletheia-foundation/aletheia-admin/blob/master/CODE-OF-CONDUCT.md) - [x] I've checked that this issue applies to this repo Hi Alethia team. I'm...
We should be able to use Travis to run the data updates daily
The initial dataset was generated using a pipeline of command-line tools. We need a robust script for updating the data and regenerating stats (see #7).
Would be cool to build a nice search / stats interface around the data. The whole dataset is small enough that we could have a small index in browser memory...