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.

Sign up for GitHub

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

Jump to bottom

[Nice to have] Generate markdown docs about the cli from urfavecli #32

Open
3 tasks
roninjin10 opened this issue Oct 18, 2023 · 0 comments
Open
3 tasks

[Nice to have] Generate markdown docs about the cli from urfavecli #32

roninjin10 opened this issue Oct 18, 2023 · 0 comments
Labels
good first issue Good for newcomers

Comments

@roninjin10
Copy link

Description

We don't want to write docs for the cli we want to generate it in a script. It appears pretty easy to do looking at this urfave/cli#830. We also want to make s

Tasks

  • Add a new scripts/ package
  • Add a script to generate markdown doc for cli app into docs/cli.md
  • (optional) Add check to circleci config that make sure generated docs are up to date
@roninjin10 roninjin10 added the good first issue Good for newcomers label Oct 18, 2023
@roninjin10 roninjin10 changed the title Generate markdown docs about the cli from urfavecli [Nice to have] Generate markdown docs about the cli from urfavecli Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@roninjin10