Open refeed opened 3 months ago
Several feedback from https://github.com/refeed/tirith-workshop
Hi sir, I really want to work on this documentation. I Will write it in the similar format as asked. Kindly assign this task to me. Thank You!
Hey @refeed since i am already working on the above-related issue, docs structure and writing other pages, I would ask you to please assign this to me, here is the structure that I will be following
Tutorial
◦ CLI usage
◦ Integrating with CI/CD
◦ Using the library for doing evaluations in Python code
◦ (another real-world usecases)
Thanks that looks great
Edit: Very sorry @harshit240205, I didn't see your message previously
Is your feature request related to a problem? Please describe. Currently, there's only a little introduction on how to use Tirith. Ideally, there should be more tutorial for at least using three providers so that potential users and contributors can get a picture on how to use Tirith and what is Tirith
Describe the solution you'd like Create a separate markdown document inside the Tirith repo. Inspiration for what the document would like: https://github.com/refeed/tirith-workshop
I also think it would be a good idea to research on some other open/closed source projects on how they are doing the getting started part
Describe alternatives you've considered We may also create a document structure that's accepted by ReadTheDocs format, but we can do it in the next iteration.