Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Needed #23

Open
rivermont opened this issue Oct 4, 2017 · 2 comments
Open

Documentation Needed #23

rivermont opened this issue Oct 4, 2017 · 2 comments
Labels
Milestone

Comments

@rivermont
Copy link
Owner

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.

@btotharye
Copy link

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.

@rivermont
Copy link
Owner Author

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.

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

No branches or pull requests

2 participants