RTD is just a template right now! #148
Comments
Note: I am sorry if I don't do pull-request for every change in the documentation, but they are always just small changes and I need to do them in the main branch to avoid issues with the building process. Once the foundation of the docs has been layed out I will start do it properly again |
The docs are now in a separate branch will should NEVER be merged or it would create total chaos. The page is also hosted by github pages again |
Please refer to MkDocs for installation and deployment: https://www.mkdocs.org/getting-started/ The docs are still not ready, I will write some text and publish it as soon as possible. |
One file left and the docs will basically be done. After that, I will review everything, correct spelling, and finally publish it, stay tuned. |
All files are finished and have been checked for spelling. Starting final merge |
As mentioned in #148, I worked on the docs lately. I am sorry I had to do a lot of commits without pull-requests, but now it should all be done.
The docs are now ready. They will be expanded in the future with new and improved information. For now, this is all I was able to come up with. |
RTD(Readthedocs) is a great way to provide information and support to others. It functions like a website and builds on its own on pull-request.
RTD will be used to create tutorials on how to install the app, contribute to the project, add new designs and edit translations.
It will also be used to inform people about frequently asked questiosn, features and issues.
This is all going to be organized in sections to create a better overview for everyone.
I had to merge the pull request containing the docs already or else the setup would not have worked, but if you click on the link right now you will notice that the stuff written there make no sense. Please be patient as I slowly write the website.
The text was updated successfully, but these errors were encountered: