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

DOCS: Add docs for scan in CLI #459

Closed
rajdip-b opened this issue Sep 21, 2024 · 6 comments · Fixed by #461
Closed

DOCS: Add docs for scan in CLI #459

rajdip-b opened this issue Sep 21, 2024 · 6 comments · Fixed by #461
Assignees
@Allan2000-Git
Labels
difficulty: 2 good first issue Good for newcomers priority: medium released scope: cli Everything related to the CLI type: documentation Improvements or additions to documentation

Comments

@rajdip-b
Copy link
Member

Description

Add documentation for the scan command in our CLI.

Solution

  • Create a file named scan.md in here
  • Check the commands and put up the docs accordingly
  • You can take reference from here
@rajdip-b rajdip-b added type: documentation Improvements or additions to documentation good first issue Good for newcomers priority: medium difficulty: 2 scope: cli Everything related to the CLI labels Sep 21, 2024
@Allan2000-Git
Copy link
Contributor

/attempt I'd like to work on this issue.

@github-actions GitHub Actions
Copy link

Assigned the issue to @Allan2000-Git!

@Allan2000-Git Allan2000-Git mentioned this issue Sep 22, 2024
Merged
10 tasks
@Allan2000-Git
Copy link
Contributor

@rajdip-b should I add examples to showcase the usage of the command as suggested by the bot?

@rajdip-b
Copy link
Member Author

It would be great if you can do so! Just don't add screenshots, instead paste the thing in a code highlighted block.

@Allan2000-Git
Copy link
Contributor

@rajdip-b I have added usage example code block. Can you review it?

@rajdip-b
Copy link
Member Author

🎉 This issue has been resolved in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Allan2000-Git Allan2000-Git

Labels
difficulty: 2 good first issue Good for newcomers priority: medium released scope: cli Everything related to the CLI type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Add documentation for scan in CLI Allan2000-Git/keyshade
2 participants
@Allan2000-Git @rajdip-b