wist icon indicating copy to clipboard operation
wist copied to clipboard

Published 20 hours ago • verified publisher icon willowtreeapps

Add documentation

Open vannuysm opened this issue 8 years ago • 4 comments

  • [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 avatar Sep 08 '17 19:09 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.

vannuysm avatar Sep 15 '17 16:09 vannuysm

would you like use to submit a pr of examples?

slheavner avatar Sep 15 '17 17:09 slheavner

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

slheavner avatar Sep 15 '17 17:09 slheavner

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.

nishtahir avatar Jan 08 '18 18:01 nishtahir