[608] Migrate Documentation to GitHub Pages

[hk21702]

Partially implements #608. Migrates documentation to use GitHub pages using the "Just the Docs" Jekyll theme. Also, includes a better formatted README file.

All information from the old wiki has been migrated. Assets have not been updated. Some content has been improved and or added, but most is the same from the old wiki.

Some pages were broken up into sub-pages to take better advantage of the flexibility that GitHub pages gives us.
Everything other than the 404 page is written in markdown.

Wiki link within RimSort has not been updated in case there is an issue with first deployment.

[Patryk-Malinowski]

What do you think about removing the table of contents for User and Dev Guide? And I only mean the table in the in the index.md files. I don't know how full these will get but I still imagine it will mainly be linking to other pages and would look cleaner and less cluttered without the TOC?

I feel like this gets worse the more links are added and can imagine a new user opening the page and being confused/overwhelmed? This can also maybe give the impression of the TOC links being different from the above links due to some differences in naming? Like Using the Rule Editor and Rule Editor could make a user think they are different links at first?

#########################################

Would it be a good idea to move the External Metadata away from basic usage?
In the image below, maybe at the end of that part say something like 'to learn more about Community rules...' etc. with a link so the users can read up about the steam workshop and community rules databases?

However at the same time I guess we want to highlight why they should use them... so maybe a way of saying 'we strongly recommend you look at this link and download/enable this'.

Or maybe keep a short and really simple paragraph on each in Basic Usage explaining what they are used for and that we strongly recommend users set it up with a link leading to the steps on how to do this?

And we can keep more detailed information away from Basic Usage if they want to give that a read?

[Patryk-Malinowski]

Oh and otherwise I think it looks great. Looking forward to when this gets merged :)

[hk21702]

What do you think about removing the table of contents for User and Dev Guide? And I only mean the table in the in the index.md files. I don't know how full these will get but I still imagine it will mainly be linking to other pages and would look cleaner and less cluttered without the TOC?

I initially wanted to do this, but as far as I can tell, you have to have a parent page when you categorize stuff like this. I could be wrong though and I'll double check.

[hk21702]

Would it be a good idea to move the External Metadata away from basic usage?
In the image below, maybe at the end of that part say something like 'to learn more about Community rules...' etc. with a link so the users can read up about the steam workshop and community rules databases?

We can. I'll look at changing it in this pr, but the goal was to just migrate existing stuff from the old wiki.

[Patryk-Malinowski]

I initially wanted to do this, but as far as I can tell, you have to have a parent page when you categorize stuff like this. I could be wrong though and I'll double check.

Just to make sure, I meant keep the parent/index.md files but remove TOC. I think I just used has_toc: false at the top of index.md to remove the TOC.

[hk21702]

Just to make sure, I meant keep the parent/index.md files but remove TOC. I think I just used has_toc: false at the top of index.md to remove the TOC.

Oh sorry, yeah can do that. Weird... for some reason that wasn't rendering at all for me on my side.

[hk21702]

Would it be a good idea to move the External Metadata away from basic usage?
In the image below, maybe at the end of that part say something like 'to learn more about Community rules...' etc. with a link so the users can read up about the steam workshop and community rules databases?

We can. I'll look at changing it in this pr, but the goal was to just migrate existing stuff from the old wiki.

Looking at this again, I will just simplify it a little. Moving it out entirely is a little overkill as we already have a databases page. But, with the new format, it can be organized a lot better to make it easier on the eyes.

[hk21702]

Just to make sure, I meant keep the parent/index.md files but remove TOC. I think I just used has_toc: false at the top of index.md to remove the TOC.

Oh sorry, yeah can do that. Weird... for some reason that wasn't rendering at all for me on my side.

Honestly, the automatic rendering you see here should be preferred, as it is automatic. So, instead, I'm going to axe the manual stuff I made back when I couldn't get it to show up on its own.

[hk21702]

I updated a bit more content, but for this PR I'm going to pause on any content updates unless it is critical.

[Patryk-Malinowski]

Removing the manual links and just leaving the generated TOC was definitely the right call. Will save us the hassle of remembering and adding new links etc. as more subpages are added.

The external metadata part looks great too, I definitely think it is easier to digest now.

[Patryk-Malinowski]

We can. I'll look at changing it in this pr, but the goal was to just migrate existing stuff from the old wiki.

Yeah sorry that might have been going past the 'structure review'. Just wanted to mention it. Obviously once we are using this we can start updating the content and adding more etc.