Documentation move to PROTEUS framework

[stuitje]

Relates to #577.

Here is my first attempt at moving the documentation to the PROTEUS framework. If this works, I can easily do it for all other repos (JANUS, Zalmoxis, etc).

Changes:

• added github workflow docs.yaml
• updated mkdocs.yml (all other documentation urls also point to proteus-framework; to avoid an extra PR later; some will be 404s now but this will be fixed this week, let me know if you'd like it different)
• changed readthedocs url in CONTRIBUTING.md to proteus-framework url.

I did not yet remove .readthedocs.yml, can be done later (or not)

@nichollsh @timlichtenberg

[nichollsh]

Thanks, Karen.

I did not yet remove .readthedocs.yml, can be done later (or not)

Why not remove it now?

[nichollsh]

Also, would it be possible for you to update the icon/favicon in the documentation pages to the PROTEUS icon? This would help us have a consistent design language for all the modules.

https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon

https://github.com/FormingWorlds/FormingWorlds.github.io/blob/main/assets/img/brand/PROTEUS_black_on_white_logo_only.png

[stuitje]

Thanks, Karen.

I did not yet remove .readthedocs.yml, can be done later (or not)

Why not remove it now?

Right now it is still required for checks to pass – that's why I was careful. I can remove it if that's best :)

[stuitje]

Also, would it be possible for you to update the icon/favicon in the documentation pages to the PROTEUS icon? This would help us have a consistent design language for all the modules.

https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon

https://github.com/FormingWorlds/FormingWorlds.github.io/blob/main/assets/img/brand/PROTEUS_black_on_white_logo_only.png

ah yes, will do!

[nichollsh]

Right now it is still required for checks to pass – that's why I was careful. I can remove it if that's best :)

Understood. I will remove the readthedocs test.

[nichollsh]

Also, the Love.jl hyperlinks can now be updated to the new repo: https://proteus-framework.org/Obliqua/

[stuitje]

@timlichtenberg after your suggestion this morning I shortened the README; and I experimented by using an LLM to convert each section of the original README into a straightforward how-to guide (adjusted and checked by me, of course). I believe this is much better than it was originally, what do you think? You can check the new docs at the readthedocs build check below. There is no explanation and reference section so far, as I did not really have material for this, but this can be added later.

[stuitje]

@timlichtenberg after your suggestion this morning I shortened the README; and I experimented by using an LLM to convert each section of the original README into a straightforward how-to guide (adjusted and checked by me, of course). I believe this is much better than it was originally, what do you think? You can check the new docs at the readthedocs build check below. There is no explanation and reference section so far, as I did not really have material for this, but this can be added later.

also, the logo does not work at the read the docs preview, but it did work in my own preview, not sure whether there is a problem there

[nichollsh]

not sure whether there is a problem there

Don't worry about the RTD preview. We will disable the RTD page anyway.
Maybe it would be useful to have the documentation workflow run on PRs? Not sure where it would be deployed.