Skip to content
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

Migrate Documentation to MkDocs #902

Merged
merged 12 commits into from
Feb 1, 2024
Merged

Migrate Documentation to MkDocs #902

merged 12 commits into from
Feb 1, 2024

Conversation

Sewer56
Copy link
Member

@Sewer56 Sewer56 commented Feb 1, 2024

Pretty tired, so I'll keep it short.

  • Removed completely outdated documentation that's no longer relevant (e.g. Roadmap from 2022).

  • Fixed incorrect outdated documentation (e.g. IFileAnalyzer hasn't existed for over half a year).

  • High quality refactors/rewrites of certain pages:

    • Home, Getting Started and all Development Guidelines Articles were severely refactored (some parts slightly rewritten) to make them pleasing to the eye and easy to understand to new contributors.
    • Quality of Development Guidelines articles improved all around; with new examples, interactive tabs for comparing code, etc.
  • Fixed formatting in all docs pages.

    • Mostly bullet points, since those don't always translate well out of the box to mkdocs
  • Added a debug function in AGameLocator which prints IDs of all local installed games.

Example Preview 0:

20240201_19h20m00s

Example Preview 1:

20240201_19h14m56s

Example Preview 2:

20240201_19h14m25s

I went quite hard in trying to make some high quality docs ahead of the traffic from C3.


TODO:

  • Enable GitHub Pages after merging.
  • Link to GitHub Pages from the main Readme.md after merging.

Instructions if you want a live local preview before merging

@Sewer56 Sewer56 requested a review from a team February 1, 2024 19:19
@halgari halgari merged commit 39cbc93 into main Feb 1, 2024
2 of 4 checks passed
@halgari halgari deleted the mkdocs branch February 1, 2024 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants