Added: start_docs.py script , and new simplified instructions

Author: Sewer56

.gitignore

@@ -348,3 +348,6 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# Python virtual environments
+venv/

Pages/contributing.md

@@ -2,21 +2,10 @@
 
 !!! info
 
-    This page shows you how to contribute to any documentation page or wiki
-    based on this template.
-
-!!! note
-
-    This theme is forked from my theme for [Nexus Docs](https://nexus-mods.github.io/NexusMods.MkDocsMaterial.Themes.Next);
-    and this page is synced with that.
+    This page shows you how to contribute to any documentation page or wiki.
 
 ## Tutorial
 
-!!! note
-
-    If you are editing the repository with the theme itself on Windows, it might be a good idea to run
-    `git config core.symlinks true` first to allow git to create symlinks on clone.
-
 You should learn the basics of `git`, an easy way is to give [GitHub Desktop (Tutorial)](https://www.youtube.com/watch?v=77W2JSL7-r8) a go.
 It's only 15 minutes 😀.
 
@@ -51,62 +40,67 @@ It's only 15 minutes 😀.
 
 ## Website Live Preview
 
-If you are working on the wiki locally, you can generate a live preview the full website.
-Here's a quick guide of how you could do it from your `command prompt` (cmd).
+If you are working on the wiki locally, you can generate a live preview of the full website.
 
-1. Install Python 3
+### Quick Start (Recommended)
 
-    If you have `winget` installed, or Windows 11, you can do this from the command prompt.
+**Prerequisites:** Python 3.7+ required.
 
-    === "Windows (winget)"
+- Linux: Typically pre-installed
+- macOS: Download from [python.org](https://python.org/)
+- Windows: Run `winget install Python.Python.3` in command prompt
+    - Or download manually from [python.org/downloads](https://python.org/downloads/)
 
-        ```bash
-        winget install Python.Python.3
-        ```
+Run the automated setup script from the project root:
 
-    === "Archlinux"
+```bash
+python3 start_docs.py
+```
 
-        ```
-        pacman -S python-pip # you should already have Python
-        ```
+This script will:
 
-    Otherwise download Python 3 from the official website or package manager.
+- Create a virtual environment if needed
+- Install all required dependencies
+- Start the MkDocs live server at http://127.0.0.1:8000 (paste into browser)
 
-2. Install Material for MkDocs and Plugins (Python package)
+### Manual Setup
 
+If you prefer to set up manually without scripts:
 
-    === "Windows/OSX"
-
-        ```bash
-        # Restart your command prompt before running this command.
-        # And open command prompt where mkdocs.yml is.
-        pip install -r ./docs/requirements.txt
-        ```
-
-    === "Linux"
+1. **Install Dependencies**
+   
+    ```bash
+    # Navigate to the docs directory
+    cd doc/docs/Reloaded
+    
+    # Create virtual environment (only needs to be done once)
+    python3 -m venv venv
+    
+    # Activate virtual environment (do this each time you work)
+    source venv/bin/activate  # On Windows: venv\Scripts\activate
+    
+    # Install requirements
+    pip install -r docs/requirements.txt
+    ```
 
-        On Linux, there is a chance that `python` might be a core part of your OS, meaning
-        that you ideally shouldn't touch the system installation.
+2. **Start Live Server**
+   
+    ```bash
+    mkdocs serve --livereload
+    ```
 
-        Use virtual environments instead.
+    ![Image](../Images/Contribute/LocalRun.png)
 
-        ```bash
-        python -m venv mkdocs # Create the environment
-        source ~/mkdocs/bin/activate # Enter the environment
+    Copy the address to your web browser and enjoy the live preview; any changes you save will be shown instantly.
 
-        # Install contents of requirements file in docs.
-        pip install -r ./docs/requirements.txt
-        ```
+## Troubleshooting
 
-        Make sure you enter the environment before any time you run mkdocs.
+### Windows Symlink Issues
 
-3. Open a command prompt in the folder containing `mkdocs.yml`. and run the site locally.
-    ```bash
-    # Move to project folder.
-    cd <Replace this with full path to folder containing `mkdocs.yml`>
-    mkdocs serve
-    ```
+If you are editing the **Reloaded.MkDocsMaterial.Themes.R2** (this wiki's theme) repository on Windows, it might be a good idea to run:
 
-    ![Image](../Images/Contribute/LocalRun.png)
+```bash
+git config core.symlinks true
+```
 
-    Copy the address to your web browser and enjoy the live preview; any changes you save will be shown instantly.
+This allows git to create symlinks on clone.

start_docs.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+"""
+Script to set up virtual environment and start MkDocs live server for documentation.
+"""
+
+import subprocess
+import sys
+import os
+from pathlib import Path
+
+def run_command(cmd, cwd=None):
+    """Run a command and handle errors."""
+    print(f"Running: {' '.join(cmd)}")
+    try:
+        result = subprocess.run(cmd, cwd=cwd, check=True, capture_output=False)
+        return result
+    except subprocess.CalledProcessError as e:
+        print(f"Error running command: {e}")
+        sys.exit(1)
+
+def main():
+    """Main function to set up docs environment."""
+    import argparse
+    
+    parser = argparse.ArgumentParser(description='Set up documentation environment')
+    parser.add_argument('--target-dir', type=str, help='Target directory for documentation (default: script directory)')
+    parser.add_argument('--project-name', type=str, default='documentation', help='Project name for messages')
+    args = parser.parse_args()
+    
+    # Use target directory if provided, otherwise use script directory
+    if args.target_dir:
+        script_dir = Path(args.target_dir)
+    else:
+        script_dir = Path(__file__).parent
+    
+    venv_dir = script_dir / "venv"
+    
+    print(f"Setting up {args.project_name} environment...")
+    
+    # Create virtual environment if it doesn't exist
+    if not venv_dir.exists():
+        print("Creating virtual environment...")
+        run_command([sys.executable, "-m", "venv", "venv"], cwd=script_dir)
+    else:
+        print("Virtual environment already exists.")
+    
+    # Determine the python executable in the venv
+    if os.name == 'nt':  # Windows
+        python_exe = venv_dir / "Scripts" / "python.exe"
+        pip_exe = venv_dir / "Scripts" / "pip.exe"
+    else:  # Unix-like
+        python_exe = venv_dir / "bin" / "python"
+        pip_exe = venv_dir / "bin" / "pip"
+    
+    # Install required packages
+    print("Installing required packages...")
+    # Install from requirements.txt first
+    requirements_file = script_dir / "docs" / "requirements.txt"
+    if requirements_file.exists():
+        run_command([str(pip_exe), "install", "-r", str(requirements_file)], cwd=script_dir)
+    
+    # Install mkdocs-material separately
+    run_command([str(pip_exe), "install", "mkdocs-material"], cwd=script_dir)
+    
+    # Start MkDocs live server
+    print("Starting MkDocs live server...")
+    print("Documentation will be available at http://127.0.0.1:8000 (paste into browser address bar)")
+    print("Press Ctrl+C to stop the server")
+    run_command([str(python_exe), "-m", "mkdocs", "serve", "--livereload"], cwd=script_dir)
+
+if __name__ == "__main__":
+    main()