Additional Documentation (#1645)

* Fixed a section of the docs removed by a developer without verification. * Fixed an incorrect link on the GettingStarted page * Added buttons to the GettingStarted page. Added login process to the GettingStarted page. Updated SystemRequirements to include information on Linux packages * Complete the AddGames section detailing how to add and remove games. * Added a small link to the more complex releases. * Added missing "s" * Convert to webp * Update SystemRequirements.md --------- Co-authored-by: erri120 <[email protected]> Co-authored-by: Timothy Baldridge <[email protected]>
Nexus-Mods · Jun 18, 2024 · d1a5755 · d1a5755
1 parent 8e721da
commit d1a5755
Show file tree

Hide file tree

Showing 10 changed files with 94 additions and 18 deletions.
diff --git a/docs/users/AddGames.md b/docs/users/AddGames.md
@@ -0,0 +1,33 @@
+# Managing Games
+
+In this guide, we'll cover adding and removing games in the app. 
+
+## Adding a Game
+To get started, head to the home screen of the app by clicking the Nexus Mods logo at the top of the spine on the left. From here, click the "My Games" option in the left menu. 
+
+![The My Games screen with Stardew Valley unmanaged.](./images/0.5.2/AddGameStardewValley.webp)
+
+This page shows a list of games that are currently supported and those that are managed by the app currently. 
+
+To add a game, simply click the "Add Game" button at the bottom of the game card.
+
+![The My Games screen with Stardew Valley in the process of being added.](./images/0.5.2/AddingGameStardewValley.webp)
+
+While the spinner is displayed the app is taking a backup of the current state of the game files which will allow you to easily restore back to this state when you're finished modding. This can take a few seconds depending on the size of the game. 
+
+Once the process is complete a new entry will be added to the spine menu on the left side. 
+
+!!! tip "Multiple Loadouts"
+    In a future release it will be possible to add multiple loadouts per game. This is currently unsupported.
+
+## Removing a Game
+!!! warning "Warning"
+    Removing a game from the app will permanently delete any loadouts. This cannot be undone.
+
+To stop managing a game with the app, click the home button at the top of the spine menu on the left, then select "My Games" in the left menu. This will open a screen with a list of both supported and managed games.
+
+![The My Games screen with Stardew Valley managed.](./images/0.5.2/GameAddedStardewValley.webp)
+
+Under the "Games Added" section, click on the :material-delete-forever: icon on the game you wish to remove. This process may take a few second as the game is reverted back to the state it was in before you started modding it. Your mods are not deleted and will still be available in the Library section next time you manage the game. 
+
+To completely remove the Nexus Mods app and all downloaded mods, please see [Uninstalling the app](./Uninstall.md).
diff --git a/docs/users/GettingStarted.md b/docs/users/GettingStarted.md
@@ -1,26 +1,36 @@
 
 !!! warning "Important Notice"
-    The Nexus Mods app is still in development and is not recommend to be used as your primary mod manager. For the latest supporter mod manager please see [Vortex](https://staticdelivery.nexusmods.com/mods/2295/images/thumbnails/1/1-1690272155-1455020317.png).
+    The Nexus Mods app is still in development and is not recommend to be used as your primary mod manager. For the latest supported mod manager please see [Vortex](https://www.nexusmods.com/site/mods/1).
 
-Before installing the app, please ensure that your PC meets the system requirements for both [the App](./SystemRequirements.md) and the game you are modding.
+Before installing the app, please ensure that your PC meets the system requirements for both [this app](./SystemRequirements.md) and the game you are modding.
 
 ## Installation
 
-### Windows
+Download the latest version of the app and run the installer on your system.
 
-Download and run the [Windows Installer] from the [latest release] on GitHub.
+[:fontawesome-brands-windows: Windows Installer](https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe){ .md-button .md-button--primary }
+[:fontawesome-brands-linux: Linux AppImage](https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x86_64.AppImage){ .md-button }
 
-### Linux
 
-#### AppImage
+<sub>[Other releases](https://github.com/Nexus-Mods/NexusMods.App/releases/latest)</sub>
 
-You can download the AppImage from the [latest release] on GitHub. Make sure you have [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) installed before running it.
+## Connect your Nexus Mods account
 
-#### System Package Manager
+To get the most out of the app, we highly recommend signing in with your Nexus Mods account. If you don't have one yet, you can make one for free [here](https://users.nexusmods.com/register). 
 
-If you want to create a package for your platform, see [Contributing](../developers/Contributing.md#for-package-maintainers) for more details.
+When you first open the app, you will have the option to sign in. If you skipped this step you can always get started by clicking the "Log In" button in the top-right of the application. 
 
-[![Packaging status](https://repology.org/badge/vertical-allrepos/nexusmods-app.svg)](https://repology.org/project/nexusmods-app/versions)
+![The top bar navigation of the app while logged out.](./images/0.5.2/Topbar.webp)
 
-[Windows Installer]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe
-[latest release]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest
+On clicking the button, a new page will open in your default web browser where you will be asked to authorise the Nexus Mods app to access your account. 
+
+!!! info "Note"
+    This process will automatically register the app to handle download from the Nexus Mods website. 
+
+![The OAuth page requesting the user to grant the app access to their account.](./images/OAuthSignIn.webp)
+
+You will then be prompted to open the app to complete the log in process. Most popular browsers have a "don't ask me again" option to avoid having to accept this message each time the website sends data to the app.
+
+![The prompt shown in Google Chrome asking users to open an NXM link with the app](./images/OpenInAppBrowserPromptChrome.webp)
+
+Congratulations, you are now logged in!
diff --git a/docs/users/SystemRequirements.md b/docs/users/SystemRequirements.md
@@ -1,23 +1,52 @@
 # System Requirements
-!!! note "This page does not include the requirements to run any supported games. Please refer to the game store page for details."
+!!! info "This page does not include the requirements to run any supported games. Please refer to the game store page for details."
 
-This page lists the recommended system requirements to install and run the app on all supported platforms. More details will be added later as the app is tested on different systems and configurations.
+This page lists the recommended system requirements to install and run the app on all supported platforms.
 
 ## Windows 
 
-* Windows 10 or 11
+!!! example "Testing required"
+    We are currently testing the app on a variety of different systems and will provide more detailed system requirements in future.
 
-## Linux
+|| Recommended |
+| --- | --- |
+| OS | Windows 10/11 with updates (64-bit OS required) |
+<!-- | Processor | A multi-core CPU is recommended |
+| Memory | More than 4 GB RAM |
+| Storage | 5GB available space* |
+
+<sub>\* Storage space required does not factor in the number of games managed, the size of the managed games and the mods installed.</sub> -->
+
+## SteamOS + Linux 
+!!! example "Testing required"
+    We are currently testing the app on a variety of different systems and will provide more detailed system requirements in future.
+
+|| Recommended |
+| --- | --- |
+| OS | A currently supported Linux distribution |
+<!-- | Processor | A multi-core CPU is recommended |
+| Memory | More than 4 GB RAM |
+| Storage | 5GB available space* |
+
+<sub>\* Storage space required does not factor in the number of games managed, the size of the managed games and the mods installed.</sub> -->
+
+### Linux Dependencies
 The App requires the following programs to be available at runtime:
 
 - `xdg-open` to open URLs in your browser.
 - `update-desktop-database` to update the MIME cache after creating a desktop entry file for the NXM link handler.
 
-If you plan to install using the AppImage, make sure you have the following dependencies installed:
+In addition, the following libraries are required:
 
+- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) if running the AppImage
 - `glibc` 2.2.5 or newer
 - `glibc++` 3.4 or newer
-- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) is required if you want to run the AppImage.
+
+### Linux Packages
+The status of packages for various Linux builds can be seen below:
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/nexusmods-app.svg)](https://repology.org/project/nexusmods-app/versions)
+
 
 ## macOS
 

diff --git a/docs/users/images/0.5.2/AddGameStardewValley.webp b/docs/users/images/0.5.2/AddGameStardewValley.webp
diff --git a/docs/users/images/0.5.2/AddingGameStardewValley.webp b/docs/users/images/0.5.2/AddingGameStardewValley.webp
diff --git a/docs/users/images/0.5.2/GameAddedStardewValley.webp b/docs/users/images/0.5.2/GameAddedStardewValley.webp
diff --git a/docs/users/images/0.5.2/Topbar.webp b/docs/users/images/0.5.2/Topbar.webp
diff --git a/docs/users/images/OAuthSignIn.webp b/docs/users/images/OAuthSignIn.webp
diff --git a/docs/users/images/OpenInAppBrowserPromptChrome.webp b/docs/users/images/OpenInAppBrowserPromptChrome.webp
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,6 +22,7 @@ markdown_extensions:
   - tables
   - pymdownx.details
   - pymdownx.highlight
+  - pymdownx.keys
   - pymdownx.superfences:
       custom_fences:
         - name: mermaid
@@ -58,6 +59,9 @@ nav:
     - Home: users/index.md
     - System Requirements: users/SystemRequirements.md
     - Getting Started: users/GettingStarted.md
+    - Adding a Game: users/AddGames.md
+    # - Features: 
+    #   - Health Check: users/features/HealthCheck.md
     - Games:
       # - users/games/index.md
       - Stardew Valley: users/games/StardewValley.md