notation icon indicating copy to clipboard operation
notation copied to clipboard

Support auto-generated CLI reference doc in the notation repo

Open FeynmanZhou opened this issue 1 year ago • 1 comments

Is your feature request related to a problem?

Currently, we generate the Notation CLI reference doc with Cobra on a local machine, then publish it to the website and maintain it per release manually. This process is not a sustainable way to maintain the CLI reference doc because there is so much manual maintenance work per new release.

What solution do you propose?

It would be efficient to update the CLI reference docs automatically by a GitHub bot with a GitHub Actions workflow. I have seen other CLI projects like minder has the workflow to automate this process.

What alternatives have you considered?

N/A

Any additional context?

No response

FeynmanZhou avatar Jan 05 '24 08:01 FeynmanZhou