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

Document all commands #411

Closed
fraxken opened this issue Aug 9, 2024 · 2 comments · Fixed by #421
Closed

Document all commands #411

fraxken opened this issue Aug 9, 2024 · 2 comments · Fixed by #421
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@fraxken
Copy link
Member

fraxken commented Aug 9, 2024

The current documentation is quite incomplete, and many commands of the tool, such as the report command, are not documented.

My idea is to keep the usage example section, but instead of including numerous tables, we could create separate documentation for each command (in a folder /docs/cli/ for example).

All commands are defined here: https://github.com/NodeSecure/cli/blob/master/bin/index.js


A bit like jsonschema CLI README:
image


image

@fraxken fraxken added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 9, 2024
@Code-Hacker26
Copy link

Hey , I am interested in contributing to this issue ,
It wouls be great if You can thow some more light to it

@fraxken
Copy link
Member Author

fraxken commented Aug 10, 2024

@Code-Hacker26 Someone is already working on it (he just didn't comment here to take ownership)

@fraxken fraxken linked a pull request Aug 17, 2024 that will close this issue
@fraxken fraxken self-assigned this Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants