ayo icon indicating copy to clipboard operation
ayo copied to clipboard

Willing to help on documentation

Open craigglennie opened this issue 7 years ago • 1 comments

Hi, this project looks like a good idea to me, so I'd like to offer help on the README and docs. I can either write them, or help with proofing and editing. If that sounds good please let me know. If you don't think this would be useful now then I am happy to assist once the code and API is more stable - just let me know at that time.

craigglennie avatar Aug 09 '18 00:08 craigglennie

Hi @craigglennie,

Thanks, it's really needed.

The first steps would be to:

  • [ ] setup sphinx
  • [ ] make sure it auto generate the API reference
  • [ ] integrate it with tox
  • [ ] integrate it with read the doc

Once we have the infra, we can start writting.

You can get some pointers from https://github.com/Tygs/ww

The doc would be setup the same way.

I'll add you to the team.

sametmax avatar Aug 09 '18 15:08 sametmax