Skip to content
This repository has been archived by the owner on Feb 19, 2023. It is now read-only.

RTD is just a template right now! #148

Closed
Benji377 opened this issue Aug 5, 2021 · 6 comments · Fixed by #149
Closed

RTD is just a template right now! #148

Benji377 opened this issue Aug 5, 2021 · 6 comments · Fixed by #149
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Benji377
Copy link
Owner

Benji377 commented Aug 5, 2021

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.

@Benji377 Benji377 self-assigned this Aug 5, 2021
@Benji377 Benji377 added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 5, 2021
@Benji377 Benji377 added this to To do in Main Ideas and Enhancements via automation Aug 5, 2021
@Benji377
Copy link
Owner Author

Benji377 commented Aug 6, 2021

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

@Benji377
Copy link
Owner Author

Benji377 commented Aug 6, 2021

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

@Benji377
Copy link
Owner Author

Benji377 commented Aug 6, 2021

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.
When done I will update and close this issue. I will also stop changing a lot of files at a time without pull-requests

@Benji377 Benji377 moved this from To do to In progress in Main Ideas and Enhancements Aug 6, 2021
@Benji377
Copy link
Owner Author

Benji377 commented Aug 8, 2021

One file left and the docs will basically be done. After that, I will review everything, correct spelling, and finally publish it, stay tuned.

@Benji377
Copy link
Owner Author

Benji377 commented Aug 8, 2021

All files are finished and have been checked for spelling. Starting final merge

Benji377 added a commit that referenced this issue Aug 8, 2021
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.
@Benji377 Benji377 linked a pull request Aug 8, 2021 that will close this issue
@Benji377
Copy link
Owner Author

Benji377 commented Aug 8, 2021

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.
I will open a new discussion to announce the opening of the docs and explain some things better

Main Ideas and Enhancements automation moved this from In progress to Done Aug 8, 2021
@Benji377 Benji377 added this to To do in Documentation via automation Aug 12, 2021
@Benji377 Benji377 moved this from To do to Done in Documentation Aug 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant