docs

Author: userdocs

docs/astro.config.mjs

@@ -33,6 +33,10 @@ export default defineConfig({
 						{
 							label: "Introduction",
 							link: "/introduction",
+                        },
+						{
+							label: "Rules of Engagement",
+							link: "/rules-of-engagement",
 						},
 						{
 							label: "Prerequisites Check List",

docs/src/content/docs/prerequisites.mdx

@@ -5,28 +5,6 @@ hide_title: true
 
 import { Advanced, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from "/src/components/global.jsx"
 
-⭐ The rules of engagement are:
-
-<Steps>
-
-1. Use Docker - to avoid conflicts with the host system, especially with Qt. Docker is the recommended method.
-
-2. Use Alpine - It is the main supported system and Debian is a testing and fallback. You do not need to build on an older host to use these binaries there.
-
-3. `sudo` - `root` is not required to run the script, but it is required to install the core dependencies if they are missing.
-
-4. Using additional flags and switches can add dependencies, like `-c` for cmake and `-cd` for cache dependencies.
-
-5. Executing the script with no arguments will only install the dependencies and configure the build environment.
-
-6. Nothing is built until you provide the `all` or a specific module name as a positional parameter to the script.
-
-7. The script has a comprehensive built-in help system. Use `bash ~/qbittorrent-nox-static.sh -h` to see the help.
-
-8. You can fork the repo and build on Github using Github Actions to create your own custom releases.
-
-</Steps>
-
 <Advanced>
 
 :::tip[Optional - Paid service for faster build times]
@@ -35,7 +13,7 @@ For faster build times you can consider a paid service like <Modal id="buildjet"
 
 </Advanced>
 
-### Prerequisite Check list
+## Prerequisite Check list
 
 If you want to self host you need to be able to meet these conditions on your host in order to use the script.
 

docs/src/content/docs/rules-of-engagement.mdx

@@ -0,0 +1,58 @@
+---
+title: Rule of engagement
+hide_title: true
+---
+
+import { Advanced, Charts, Details, Modal, Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from "/src/components/global.jsx"
+
+⭐ The rules of engagement are:
+
+<Steps>
+
+1. ### Use Docker
+
+    - Docker is the recommended method to build using the script.
+    - This will avoid many potential issues and conflicts with the host system, especially with Qt.
+
+2. ### Use Alpine
+
+    - It is the main supported system and Debian is testing and fallback.
+    - You do not need to build on an older host to use these binaries there.
+
+3. ### Privileges
+
+    - `sudo` - `root`  are not required to run the script.
+    - They are required to install the core dependencies if they are missing
+
+4. ### Additional flags and switches
+
+    - can add dependencies on demand that will need to be installed.
+    - like `-c` for cmake and `-cd` for cache dependencies.
+    - the script will require you to install these on demand.
+    - Using `.qbt_env` or setting variables before running the script will do this automatically.
+
+5. ### Passing no arguments
+
+        :::tip
+        `qbt-nox-static.bash` is the recommended build script
+        :::
+
+    - `qbt-nox-static.bash` - will make no changes and instead provide information on what you need to do.
+    - `qbittorrent-nox-static.sh` - will automatically install the required dependencies and configure the build environment.
+
+6. ### Nothing is built until...
+
+    - you provide the `all` or a specific module name as a positional parameter to the script.
+    - applies to both `qbt-nox-static.bash` and `qbittorrent-nox-static.sh`
+
+7. ### Use the help.
+
+    - Use `bash ~/qbittorrent-nox-static.sh -h` to see the help.
+    - applies to both `qbt-nox-static.bash` and `qbittorrent-nox-static.sh`
+
+8. ### fork the repo
+
+    - build on Github using Github Actions to create your own custom releases.
+    - The easiest way to get custom builds for your needs.
+
+</Steps>