Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support auto-generated CLI reference doc in the notation repo #859

Open
FeynmanZhou opened this issue Jan 5, 2024 · 1 comment
Open
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Jan 5, 2024

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 FeynmanZhou added enhancement New feature or request triage Need to triage labels Jan 5, 2024
@yizha1 yizha1 added good first issue Good for newcomers and removed triage Need to triage labels Jan 9, 2024
Copy link

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.

@github-actions github-actions bot added the Stale label Mar 22, 2024
@yizha1 yizha1 added this to the Future milestone Mar 22, 2024
@yizha1 yizha1 removed the Stale label Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Status: Todo
Development

No branches or pull requests

2 participants