-
Notifications
You must be signed in to change notification settings - Fork 7
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 #1
Comments
Fixed via #23 |
Some topics are still not covered though. Quick start/Installation is definitely an important piece which is still missing. |
Ok, reopening to tracking missing bits. However, quick start / installation is in README and +/- actual. |
Not sure what should we put there. I tend to think that the "Installation" page from #28 would cover this.
Still missing. There's a convention at GitHub to put such a guide in a CONTRIBUTING.md file (instead of RTD), so I suggest to follow it.
Done.
Done (sort of).
Still missing. Any idea what should be covered here? |
We need document what we have here. Currently all we have is reference to source code. That's geeky, but not user friendly. Documentation should cover at least the following topics:
The text was updated successfully, but these errors were encountered: