Add documentation

[vannuysm]

• [x] User's Guide
  • [x] Configuration
  • [x] CLI
  • [x] Rules
• [ ] Developer's Guide
  • [x] Getting Started
  • [ ] Create rules
  • [ ] API documentation
  • [x] Contributing
  • [ ] Architecture
• [x] About
  • [x] History
  • [x] Philosophy
  • [x] Contributors

[vannuysm]

@slheavner @jdwitten @bret-fears It would be great to get y'alls input on the documentation. If you could take a look at the rules and add some context around them. Possibly even some 👍 code examples and some 👎 code examples that would be awesome. For reference I'm basing the concept on something like this.

[slheavner]

would you like use to submit a pr of examples?

[slheavner]

Also, all documentation needs to mention roku. It mentions plenty of brightscript, but it's also important to include roku. Makes searching easier

[nishtahir]

We should include a way to generate rule documentation from comments on the rules. That way we only need to make sure that the rules are properly commented and the rest will take care of itself.