-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update the documentation #434
Comments
In my opinion we should update the sphinx theme, RTD is not very pretty. We should consider to move from sphinx to mkdocs due to the simplicity of editing markdown compared to rst. |
When migrating the documentation from .rst to .mk this would also give the opportunity to sort out old stuff. |
We could have the following structure. I marked Main Content:
Few more thoughts:
|
Deadline: 15.10.2023
Our documentation page is not really up to date. I heard from some people that they have problems using the open-mastr based on the documentation page.
- [ ] Check if mike versioning works on readthedocs @chrwmadvanced.md
file @FlorianK13datasets.md
put description of tables in an tabs element @FlorianK13datasets.md
put original data model screenshot and translated on in tabs element @FlorianK13advanced/config.md
see if the project directory descrpition is up to date and add descriptions for missing files / folders @chrwm.rst
files when the work is finished @FlorianK13 @chrwmIdeas of solution
We have outdated chapters that can be deleted - they still can be accessed if the documentation of earlier versions is still hosted in readthedocs.
Workflow checklist
The text was updated successfully, but these errors were encountered: