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

docs: Rework naming convention and status description requirements #118

Open
wants to merge 29 commits into
base: main
Choose a base branch
from

Conversation

mattmaniak
Copy link
Member

@mattmaniak mattmaniak commented Nov 1, 2024

Description

Type(s)

  • Game page addition
  • Game page modification
  • Other wiki edit

Verification

Have you

  • Followed the contribution guidelines?
  • Ran ./scripts/generate.mjs?
  • Ran ./scripts/lint.mjs?
  • Checked spelling and grammar?
  • (If applicable) Provided documentation for a game not working? (i.e. detailing what happens when the game doesn't work?)

Most likely the biggest PR of all times here but it addresses some things that make docs navigation, maintenance and lack of some details issues:

  • Abbrevations are no longer allowed and present. As the game titles are sorted alphabetically via markdown files names it's getting messier and messier with a proper ordering - some titles were completely somewhere else than expected. Also with a growing database of tested games, acronyms make things harder to maintain. Not everyone of us knows each acronym of each game and while we can easiliy search them via code editor it still gets messy when some markdown files are acronyms, some are partial acronyms and some are not at all. This PR provides a consistency of no acronyms with an exception of "goty" - Game of the Year which is well known.
  • Every know issue occurence that was listed before on a game page was moved under a [!WARNING] heading to keep any games issues in one place.
  • Names of the games were updated and taken directly from Steam for consistency. An idea has started here. It may be automated in a future using a Steam API most likely where a GitHub Actions would check for the game name using a given Steam app ID.
  • Minor formatting issues were applied for a better consistency and legibility.
  • Nothing new has been added to games performance info apart of the broken REDlauncher in The Witcher 3.

Any maintainer feedback is welcome as it is a huge change and it is better to discuss it before deploying but I hope that my idea and implementation have a solid background.

@hahayupgit hahayupgit added the docs enhancement New feature or request label Nov 7, 2024
@JoshuaBrest
Copy link
Contributor

I can add a lint feature later.

@mattmaniak
Copy link
Member Author

I can add a lint feature later.

You're welcome :) @hahayupgit any thoughts on PR?

@mattmaniak mattmaniak removed the request for review from IsaacMarovitz November 27, 2024 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants