Skip to content
This repository has been archived by the owner on May 26, 2023. It is now read-only.

Add documentation #15

Open
10 of 14 tasks
vannuysm opened this issue Sep 8, 2017 · 4 comments
Open
10 of 14 tasks

Add documentation #15

vannuysm opened this issue Sep 8, 2017 · 4 comments

Comments

@vannuysm
Copy link
Contributor

vannuysm commented Sep 8, 2017

  • User's Guide
    • Configuration
    • CLI
    • Rules
  • Developer's Guide
    • Getting Started
    • Create rules
    • API documentation
    • Contributing
    • Architecture
  • About
    • History
    • Philosophy
    • Contributors
@vannuysm vannuysm added this to the 1.0.0 milestone Sep 8, 2017
@vannuysm
Copy link
Contributor Author

@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
Copy link
Contributor

would you like use to submit a pr of examples?

@slheavner
Copy link
Contributor

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

@vannuysm vannuysm added the docs label Oct 12, 2017
@nishtahir
Copy link
Member

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants