spidy
spidy copied to clipboard
Documentation Needed
CONTRIBUTING.md
has some guidelines, but essentially there is simply a lot of stuff that needs filled out in the docs.
Also, if you would like to use another documentation format feel free. Listing everything is something I came up with in early development but it's probably not scalable.
anything specific you are looking for in the documentation? To give you an idea of some previous sites I've helped on there is https://docs.mycroft.ai which is based on MD using grav or there is just standard MD like https://github.com/MycroftAI/mycroft-skills/blob/master/README.md, let me know how I can help and what you need on the docs.
Currently DOCS.md
is written in standard Markdown. I feel like the readability is impaired by the format - just a list of all variables and functions available in crawler.py
, but I'm not sure what would be better.