Documentation v2 📝

[sreichel]

Description (*)

Use mkdocs for better documentaion at https://openmage.readthedocs.io

Related Pull Requests

1. See [WIP] Refactor DOCs using mkdocs 📝  #2984

Manual testing scenarios (*)

1. follow 74507da to install mkdocs
2. run mkdocs serve

Questions or comments

Pros:

• docs not splited to readme, readthedocs, docs direcory
• modern flare
• easier to extend (!)
• should work with readthdocs.io
• ...

Cons:

Have to install python3 (?)

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All automated tests passed successfully (all builds are green)
• Add yourself to contributors list

[rnicklin]

Unirgy no longer offers this module for M1. Probably not worth including in this documentation.

[m-overlund]

are you sure?
we have it, and they released a new version in april this year - they still develop it.

[sreichel]

Need some help to automate pushing to openmage.readthedocs.com.

• https://github.com/marketplace/actions/deploy-mkdocs
• https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions-material-for-mkdocs

[Flyingmana]

ReadTheDocks works pull not push based.

I can change repository and documentation type after the merge, but there is no way to build the documentation ourself there.

I did not follow the discussion around the documentation to the end, can you link to the decision in your PR for a cross check?

[sreichel]

Seems mkdocs-support is built in ... https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html

(point docs to RTD should work out of th box)

[sreichel]

can you link to the decision in your PR for a cross check?

Decision about Wiki/Pages/Else discussion? Guess it was in the githubio-repo ?!? Have to search for it.