-
Notifications
You must be signed in to change notification settings - Fork 732
Documentation Update Planning
Justin edited this page Apr 29, 2015
·
1 revision
Potential areas where Brakeman documentation could be improved:
- Update and expand FAQ - http://brakemanscanner.org/docs/faq/
- Update and expand options documentation, particularly with use cases (and when NOT to use) - http://brakemanscanner.org/docs/options/)
- Also delete or update https://github.com/presidentbeef/brakeman/wiki/Brakeman-Commandline-Options?
- Make website friendlier
- Document best practices, real-world use
- Add quick start or 5 minute introduction to using Brakeman
- Document how to create new checks/rules
- Document how to read reports
- Document the code