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

Improve documentation to include novice users #9

Closed
desilinguist opened this issue Jul 14, 2019 · 2 comments
Closed

Improve documentation to include novice users #9

desilinguist opened this issue Jul 14, 2019 · 2 comments

Comments

@desilinguist
Copy link

There's no documentation for this project at all which is less than ideal. Basically, this project assumes that you are extremely well-versed in reinforcement learning and can figure out how to run this codebase yourself by looking at the code. For example, I am a complete novice and I couldn't figure out how to easily try something out using this codebase once I had finished installation. Even the quick start section in the README is not a complete example.

I would recommend that you create actual documentation on readthedocs.org that explains what RL is, what this codebase does for RL compared to other things, and provide a complete end-to-end example on how to use this codebase. The rest of the API and the modules should also be documented clearly.

@alexanderimanicowenrivers

This is also now complete #10

Thanks!

@alexanderimanicowenrivers

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

No branches or pull requests

2 participants