Merge branch 'main' into fix/cache-key-as-string

.github/ISSUE_TEMPLATE/doc_request.md

@@ -0,0 +1,21 @@
+---
+name: 📚 Documentation
+about: Help with documentation improvements.
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Documentation request
+
+Documentation is a high priority for outlines. If you would like to see something added to the documentation, please help us out by:
+
+- Checking to see if the documentation does not already exist.
+- Providing a detailed explanation of what you'd like to understand better.
+- Highlighting any specific difficulties you ran into.
+
+### Are you willing to open a PR?
+
+Tell us whether you are willing to submit a PR for this yourself, we'd greatly appreciate it!
+
+Thanks for contributing!

README.md

@@ -7,6 +7,7 @@
 [![.txt Twitter][dottxt-twitter-badge]][dottxt-twitter]
 [![Outlines Twitter][outlines-twitter-badge]][outlines-twitter]
 
+[![Documentation][documentation-badge]][documentation]
 [![Contributors][contributors-badge]][contributors]
 [![Downloads][downloads-badge]][pypistats]
 [![Discord][discord-badge]][discord]
@@ -355,6 +356,8 @@ answer = outlines.generate.text(model)(prompt, max_tokens=100)
 }
 ```
 
+[documentation]: https://outlines-dev.github.io/outlines/welcome/
+[documentation-badge]: https://img.shields.io/readthedocs/outlines
 [contributors]: https://github.com/outlines-dev/outlines/graphs/contributors
 [contributors-badge]: https://img.shields.io/github/contributors/outlines-dev/outlines?style=flat-square&logo=github&logoColor=white&color=ECEFF4
 [dottxt-twitter]: https://twitter.com/dottxtai