You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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 ?
The text was updated successfully, but these errors were encountered: