Merge pull request #118 from mattmaniak/main

docs: Rework naming convention and status description requirements

README.md

@@ -32,7 +32,7 @@ Documentation for Whisky.
    - Ensure accuracy. Don't upload misleading information, false reports, guesses, or improper research.
    - Cite your sources. Found a guide from somewhere else? Found a solution or other thing online? Provide a link in your page. This isn't a requirement that's going to get your PR rejected, but simply one that future-proofs things and ensures that if a game suddenly breaks, we can check our sources and see if there are any updates to the solutions found.
    - Document the installation process and any errors that arise during the installation. If installation fails, set `installs=No` in the `Ratings` template.
-   - Document whether a program opens by setting `opens=Yes` in the `Ratings` template. A program is considered "open" if it launches the title screen or main menu. Dialog messages don't count as a program "opening".
+   - Document whether a program opens by setting `opens=Yes` in the `Ratings` template. A program is considered "open" if it launches the title screen or main menu. Dialog messages don't count as a program "opening". Write down all issues that you have noticed while playing a title under a `> [!WARNING]` heading.
    - Add status ratings to your game based on the following scale. We leave this up to general author interpretation, but please make sure you're still following these general guidelines:
 
     | Status   | Description                                                                                    |
@@ -44,14 +44,16 @@ Documentation for Whisky.
     | Garbage  | Game is unplayable.                                                                            |
 
 1. Create a new markdown file in `~/whisky-book/src/game-support` with the name of the game.
-   - Format your file in all lowercase, using only alphabetical, numerical, and dash characters, and use abbreviations where possible. i.e:
+   - Format your file in all lowercase, using only alphabetical, numerical, and dash characters. Do not use abbreviations as they mess up titles ordering with an exception of `goty` which stands for "Game of the Year" and is used among many titles and known as a standard. Use a dash sign (`-`) everytime a space occurs in the original title. Replace roman numerals with arabic ones to distinguish words from numbers. Do not insert any [articles](https://www.grammarly.com/blog/parts-of-speech/articles/) in a markdown file name (`a`, `the`). Remember to match a filename with a full game title (eg. from Steam) using above exceptions and restrictions. If a game is not listed on Steam then add the store/page name at the very end of the file like `<some-game>-gog` i.e:
    ```
-   Metal Gear Solid V: The Phantom Pain -> mgs-5.md
-   Persona 3 Reload -> p3r.md
-   Star Wars Jedi: Fallen Order -> sw-fallen-order.md
-   Geometry Wars 3: Dimensions Evolved -> gw3-dimensions-evolved.md
+   Diablo IV (Battle.net) -> diablo-4-battle-net
+   Geometry Wars 3: Dimensions Evolved -> geomatry-wars-3-de.md
+   Metal Gear Solid V: The Phantom Pain -> metal-gear-solid-5-phantom-pain.md
+   Persona 3 Reload -> persona-3-reload.md
+   Star Wars Jedi: Fallen Order -> star-wars-jedi-fo.md
+   Wolfenstein II: The New Colossus -> wolfenstein-2-new-colossus.md
    ```
-2. Add the following template to your markdown file.
+2. Add the following template to your markdown file. Ensure that the game name you enter at the beginning of the file matches Steam or other store listing name fully, including capitalization. However remove any character that is not an ASCII printable character. You can find the allowed characters list [here](https://www.ascii-code.com/characters/printable-characters).
    ```
    # <Full Game Name Here>
 
@@ -69,13 +71,13 @@ Documentation for Whisky.
    
    ## Setup
    
-   - Install in Steam as normal
-   - In Whisky, find `SwGame-Win64-Shipping.exe` in the Program list and run it
+   - Install in Steam as normal.
+   - In Whisky, find `SwGame-Win64-Shipping.exe` in the Program list and run it.
    
    {{#template ../templates/steam.md id=1172380}}
    
    ```
-   <img width="815" alt="Screenshot 2024-04-16 at 10 06 11 PM" src="https://github.com/Whisky-App/whisky-book/assets/161992562/d7d61b1a-5d02-4961-8ff5-b953c2a2fbe1">  
+   <img width="815" alt="Preview of Star Wars Jedi: Fallen Order Whisky documentation page" src="https://github.com/Whisky-App/whisky-book/assets/161992562/d7d61b1a-5d02-4961-8ff5-b953c2a2fbe1">  
 3. Run the `generate` script with `./scripts/generate.mjs` to update `SUMMARY.md`.
    This will also make the game appear in the sidebar of the book.
 4. Run `./scripts/lint.mjs` to ensure that your changes are properly formatted.