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

[Feature]: Auto document cli in markdown #6

Open
5 tasks done
olih opened this issue Jan 22, 2022 · 0 comments
Open
5 tasks done

[Feature]: Auto document cli in markdown #6

olih opened this issue Jan 22, 2022 · 0 comments

Comments

@olih
Copy link
Member

olih commented Jan 22, 2022

Describe the problem

Usually, CLI program gets documented in markdown so potential users get an understanding of the available features.
This is usually a manual process, and often the code will change but the documentation will not be updated.

Describe the solution

New command for the cli baldrickdoc-ts cli
Auto generate the documentation for the CLI based on the --help
The easiest approach is just to capture the --help for each command and enclose it as fenced code.

The newly generated documentation can be then saved in new markdown file CLI.md

Additional context

Right now, we are using commander.js for the CLI, but this could change in the future.

Is this new feature a good fit ?

  • Needed: an existing user is going to need this in the short term
  • Specific: the problem is clearly understood and defined
  • Small change: This new feature represents a reasonably small change
  • Same scope: this new feature does not change significantly the scope of this project
  • Long term maintenance: moving this to a new project would make long term maintenance harder
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant