Support auto-generated CLI reference doc in the notation repo

[FeynmanZhou]

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

[github-actions]

This issue is stale because it has been opened for 60 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days.

[boorah]

Hey @FeynmanZhou,
I'd like to work on this issue.

I see that the current set of docs are maintained in a separate repository - https://github.com/notaryproject/notaryproject.dev/tree/main/content/en/docs/user-guides/cli-reference

Question: So the expectation is to create a PR in the above repo (notaryproject.dev) with updated docs every time there's a change in the commands in this repo?

I had a look at the sample workflow you linked, planning to implement those changes

Thanks!

[FeynmanZhou]

Hi @boorah ,

Thanks for your interest! Yes, you are correct.

Here is an example implementation that we did for ORAS CLI reference doc: https://github.com/oras-project/oras-www/tree/main/tools and see the relevant issue.

If you are interested in this issue, we could assign this one to you. Thanks

[boorah]

Yes, I'd like to work on this