You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We want to have a new website that is built on top of a new site generator that will make maintenance and setup of docs much simpler. Additionally, a new hosting provider should be used so that hosting of the website will be easier as well.
Details
After the initial research done in #2458, the plan is to move the docs to MkDocs and use the Material for MkDocs theme which comes with lots of extra features that take work off of the team's hands when it comes to customization of the website.
For hosting, ReadTheDocs will be used since it provides features that are tailored towards technical documentation which again, will make maintainability better.
Versioning of the website will be removed from the website for now since the project doesn't really need it except for certain specific pages like the Upgrade page.
Goal
We want to have a new website that is built on top of a new site generator that will make maintenance and setup of docs much simpler. Additionally, a new hosting provider should be used so that hosting of the website will be easier as well.
Details
After the initial research done in #2458, the plan is to move the docs to MkDocs and use the Material for MkDocs theme which comes with lots of extra features that take work off of the team's hands when it comes to customization of the website.
For hosting, ReadTheDocs will be used since it provides features that are tailored towards technical documentation which again, will make maintainability better.
Versioning of the website will be removed from the website for now since the project doesn't really need it except for certain specific pages like the Upgrade page.
PoC for this epic with a fully working setup: https://github.com/mowies/mkdocs-testing
The corresponding website can be accessed here: https://mkdocs-testing.readthedocs.io/en/stable/
The corresponding ReadTheDocs project can be accessed here: https://readthedocs.org/projects/mkdocs-testing/
Tasks
include
shortcodes #2587The text was updated successfully, but these errors were encountered: