contextualise
contextualise copied to clipboard
brettkromkamp
Write documentation (user guide)
@brettkromkamp I am available for user documentation. I may not be able to create install / technical bits. I am happy to create a user guide / tutorial. Kindly advise your preferred format or we could create a map.
@navigator8 Thank you! Much appreciated. My initial thinking is to use a tool like Sphinx or MkDocs with a Read the Docs theme. The nice thing with, for example, MkDocs is that the documentation is written in Markdown and that the static site it generates can effectively be hosted anyway --- so, easy to manage. I'll play around a bit with these tools and get back to you :) Thanks again. Your help is appreciated!
@navigator8 Contextualise's documentation will be done with Read the Docs together with Sphinx, a very popular documentation system for open source applications. To contribute with regards to the documentation you would have to clone the repo and provide the documentation files (in RestructuredText format) after which you would submit pull requests (PRs) with your changes.
Check out Sphinx's documentation, here: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html. The documentation source files are here: https://github.com/brettkromkamp/contextualise/tree/master/docs
Let me know if you have any questions with regards to this matter. I'll be glad to be of assistance :)
@navigator8 I have moved Contextualise's documentation into its own repository, here: https://github.com/brettkromkamp/contextualise-docs
Check out the documentation, here: https://contextualise.readthedocs.io/en/latest/about/introduction.html or https://contextualise.readthedocs.io/en/latest/index.html.
Obviously, it is unfinished. But, everything is in place, including the tools, GitHub repo and hosting (by ReadTheDocs).