Figure out where to host documentation!
Closed this issue · 5 comments
Julian has already got us off the ground with documentation by suggesting we use Sphinx! (#31)! Seems like a great solution - however some issues that still need to be resolved/I am currently taking a look at are:
- Add a pipeline that allows us to build/update the docs with every change to the main branch.
- Figure out storage and versioning control for the various doc versions!
- Figure out how to store and serve all our documentation files!
- Add instructions for how to add to the docs/how to work with Sphinx.
Feel free to jump in with suggestions!
I know it might seem a bit fiddly but, since our user base is currently so small I think it could be worth taking some extra time to think about how we want to set up the documentation both to make rendseq easier for both future users to understand/use and for future contributors to make changes to with as little effort as possible :) I have a few deadlines early this week - so may not get to some of the points above until mid/end of next week, but hope to have this up and running soon/ready for feedback! :)
As I mentioned in #31 I think ReadTheDocs could be a good place to host our documentation. Would essentially follow this tutorial to do so if we decide to go in that direction. :) if y'all agree would be happy to implement that later this week - but please lmk your thoughts/any objections or concerns!
And to be clear - totally think Julian's idea to use Sphinx to automatically generate most of the documentation files is a great suggestion - I think we should go with it! :) For now - just think it would be worth settling the question of where we want to host the documentation/other questions around documentation!
Ok mostly closed - will open some of the remaining steps as a new issue