CHAI icon indicating copy to clipboard operation
CHAI copied to clipboard

Your current Documentation is broken

Open mostroot opened this issue 5 years ago • 2 comments

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 :)

mostroot avatar Jan 13 '20 20:01 mostroot

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 [email protected] if you have any specific questions, and in the meantime, we will use this issue as some motivation to get our documentation in order!

davidbeckingsale avatar Jan 14 '20 02:01 davidbeckingsale

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

mostroot avatar Jan 14 '20 15:01 mostroot