search

alexdresko / HSPI

HomeSeer plugin helper framework
MIT License
11 stars 11 forks source link

Document the template code #2

Open alexdresko opened 7 years ago

alexdresko commented 7 years ago

The template code doesn't do a good job of explaining what to do next.

fuzzysb commented 7 years ago

Agreed i have just started today and have struggled to get a start to be honest. if and when the penny drops and i get it, i will contribute to documentation as the project is in urgent need of further documentation.

alexdresko commented 7 years ago

@fuzzysb Any help is much appreciated, thanks! It takes a bit to get used to RestructuredText format, but it's pretty nice. I added a gulp watch action that will pull up a browser preview.

oesolberg commented 7 years ago

I can always help with a bit of documenting. Just point me in the direction of how to do it.

alexdresko commented 7 years ago

I'll work on some documentation documentation soon. :)

alexdresko commented 7 years ago

@fuzzysb @oesolberg I put together some instructions for contributing documentation to HSPI. It's on the dev branch right now at http://hspi.readthedocs.io/en/dev/docs.html. I don't know your experience with this kind of stuff, but if you're truly interested in helping, let me know if there's anything I can do to help you.

oesolberg commented 7 years ago

Cool. I have installed all the neccessary software. Now I need to learn how to produce something with it.

fuzzysb commented 7 years ago

@alexdresko thanks for this, when i get some time over the coming weeks i will get onto this as i learn more with the ttemplate

alexdresko commented 7 years ago

@fuzzysb @dpmurphy @zshall and @oesolberg... Odd place to announce this, I know, but... https://hspiweb.wordpress.com/