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

Your current Documentation is broken #94

Open
mostroot opened this issue Jan 13, 2020 · 2 comments
Open

Your current Documentation is broken #94

mostroot opened this issue Jan 13, 2020 · 2 comments

Comments

@mostroot
Copy link

Documentation found here: https://chai.readthedocs.io/en/develop/
Which is linked in your readme has major sections missing.
For example the tutorial section is a stub found here: https://chai.readthedocs.io/en/develop/tutorial.html
Code documentation is also a stub found here:
https://chai.readthedocs.io/en/develop/code_documentation.html

I came across your library and would like to use it, but I'd love to be able to see what it does first :)

@davidbeckingsale
Copy link
Member

Hey @mostroot, thanks for checking out the library. Our documentation is still a work in progress, the code in the "examples" directory demonstrates most of the functionality of CHAI.

Please feel free to reach out to chai-dev@llnl.gov if you have any specific questions, and in the meantime, we will use this issue as some motivation to get our documentation in order!

@mostroot
Copy link
Author

Thanks! I will definitely reach out if I run into any questions :)

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