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

Move and consolidate docs #264

Open
sa7mon opened this issue Dec 6, 2023 · 0 comments
Open

Move and consolidate docs #264

sa7mon opened this issue Dec 6, 2023 · 0 comments
Labels
refactor Code cleanup / optimization
Milestone
Future

Comments

@sa7mon
Copy link
Owner

sa7mon commented Dec 6, 2023 •
edited
Loading

The README is really long and can be daunting. Let's keep the readme short to give a quick overview and move all the details to markdown files. Maybe under /docs?

  • Detailed usage - moved from readme
  • Providers
    • list all supported providers and any weirdness with them
    • which providers support authenticated scans (only AWS for now)
    • how to add a new provider
  • Setting up the development environment
  • custom config file format
  • List of other APIs to test from the wiki
  • Permissions - understanding the results
  • Nice graphic highlighting the sections of the default output format
@sa7mon sa7mon added the refactor Code cleanup / optimization label Dec 6, 2023
@sa7mon sa7mon added this to the Future milestone Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
refactor Code cleanup / optimization
Projects
None yet
Milestone
Future
Development

No branches or pull requests
1 participant
@sa7mon