Documentation - Docusaurus port

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-### Have you checked the GP2040-CE documentation [HERE](https://gp2040-ce.info/#/) to confirm this feature doesn't already exist?
+### Have you checked the GP2040-CE documentation [HERE](https://gp2040-ce.info/) to confirm this feature doesn't already exist?
 
 Yes/No
 

.github/ISSUE_TEMPLATE/issue---bug-report.md

@@ -12,7 +12,7 @@ assignees: ''
 Please check the following before posting an issue / bug report.
 
 - [ ] I am running the latest version of the firmware found [HERE](https://github.com/OpenStickCommunity/GP2040-CE/releases)
-- [ ] I have checked the documentation [HERE](https://gp2040-ce.info/#/) and found no answer
+- [ ] I have checked the documentation [HERE](https://gp2040-ce.info/) and found no answer
 - [ ] I checked to make sure that this issue has not already been filed [HERE](https://github.com/OpenStickCommunity/GP2040-CE/issues)
 - [ ] I am reporting the issue to the correct repository
 

.github/workflows/deploy.yml

@@ -0,0 +1,45 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+
+      - name: Install dependencies
+        run: npm install --frozen-lockfile
+        working-directory: site
+      - name: Build website
+        run: npm run build
+        working-directory: site
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.ACTION_SECRET }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: site/build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/test-deploy.yml

@@ -0,0 +1,26 @@
+name: Test Docs Deployment
+
+on:
+  pull_request:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  test-deploy:
+    name: Test docs deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+
+      - name: Install dependencies
+        run: npm install --frozen-lockfile
+        working-directory: site
+      - name: Test build website
+        run: npm run build
+        working-directory: site

.gitignore

@@ -12,5 +12,4 @@ lib/httpd/fsdata.c
 modules/Custom.cmake
 .idea
 cmake-*
-env.ini
-
+env.ini

README.md

@@ -26,7 +26,7 @@
 
 ## Links
 
-[Downloads](https://gp2040-ce.info/#/download) | [Installation](https://gp2040-ce.info/#/installation) | [Wiring](https://gp2040-ce.info/#/wiring) | [Usage](https://gp2040-ce.info/#/usage) | [FAQ](https://gp2040-ce.info/#/faq) | [GitHub](https://github.com/OpenStickCommunity/GP2040-CE)
+[Downloads](https://gp2040-ce.info/downloads/download-page) | [Installation](https://gp2040-ce.info/installation) | [Wiring](https://gp2040-ce.info/controller-build/wiring) | [Usage](https://gp2040-ce.info/usage) | [FAQ](https://gp2040-ce.info/faq/faq-general) | [GitHub](https://github.com/OpenStickCommunity/GP2040-CE)
 
 Full documentation can be found at <https://gp2040-ce.info>
 
@@ -38,16 +38,16 @@ Full documentation can be found at <https://gp2040-ce.info>
 * Left and Right stick emulation via D-pad inputs as well as dedicated toggle switches.
 * Dual direction via D-pad + LS/RS.
 * Reversed input via a button.
-* [Turbo and Turbo LED](https://gp2040-ce.info/#/add-ons/turbo) with selectable speed
+* [Turbo and Turbo LED](https://gp2040-ce.info/add-ons/turbo) with selectable speed
 * Per-button RGB LED support.
 * PWM Player indicator LED support (XInput only).
 * Multiple LED profiles support.
 * Support for 128x64 monochrome I2C displays - SSD1306, SH1106, and SH1107 compatible.
 * Custom startup splash screen and easy image upload via web configuration.
 * Support for passive buzzer speaker (3v or 5v).
-* [Built-in, embedded web configuration](https://gp2040-ce.info/#/web-configurator) - No download required!
+* [Built-in, embedded web configuration](https://gp2040-ce.info/web-configurator) - No download required!
 
-Visit the [GP2040-CE Usage](https://gp2040-ce.info/#/usage) page for more details.
+Visit the [GP2040-CE Usage](https://gp2040-ce.info/usage) page for more details.
 
 ## Performance
 
@@ -58,7 +58,7 @@ Input latency is tested using the methodology outlined at [WydD's inputlag.scien
 | v0.7.5 | All modes (except PS4) | 1 ms | 0.45 ms | 1.28 ms | 0.77 ms | 0.24 ms | 96.27% | 3.73% | 0% |
 | v0.7.5 | PS4 Mode | 1 ms | 1.34 ms | 2.01 ms | 1.72 ms | 0.16 ms | 90.55% | 9.45% | 0% |
 
-Full results can be found in the [GP2040-CE Firmware Latency Test Results](https://raw.githubusercontent.com/OpenStickCommunity/GP2040-CE/main/docs/latency_tests/GP2040-CE_Firmware_Latency_Test_Results.xlsx) .xlsx Sheet.
+Full results can be found in the [GP2040-CE Firmware Latency Test Results](https://raw.githubusercontent.com/OpenStickCommunity/GP2040-CE/main/site/latency_tests/GP2040-CE_Firmware_Latency_Test_Results.xlsx) .xlsx Sheet.
 
 ## Support
 

configs/AlpacaOwO/BoardConfig.h

@@ -276,7 +276,7 @@
 #define KEY_BUTTON_A1   HID_KEY_9             // A1 / Guide / Home / PS / 13 / ~
 #define KEY_BUTTON_A2   HID_KEY_F2            // A2 / ~ / Capture / ~ / 14 / ~
 
-// For details on this, see: https://gp2040-ce.info/#/development?id=i2c-display-splash
+// For details on this, see: https://gp2040-ce.info/development?id=i2c-display-splash
 #define DEFAULT_SPLASH \
 	0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \
 	0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \

configs/BentoBox/BoardConfig.h

@@ -254,7 +254,7 @@
 #define KEY_BUTTON_A1   HID_KEY_9             // A1 / Guide / Home / PS / 13 / ~
 #define KEY_BUTTON_A2   HID_KEY_F2            // A2 / ~ / Capture / ~ / 14 / ~
 
-// For details on this, see: https://gp2040-ce.info/#/development?id=i2c-display-splash
+// For details on this, see: https://gp2040-ce.info/development/firmware-development#i2c-display-splash
 #define DEFAULT_SPLASH \
   0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \
   0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \

configs/Pico/BoardConfig.h

@@ -317,7 +317,7 @@
 #define PSPASSTHROUGH_HOST_PIN_DPLUS -1
 #define PSPASSTHROUGH_HOST_PIN_5V -1
 
-// For details on this, see: https://gp2040-ce.info/#/development?id=i2c-display-splash
+// For details on this, see: /https://gp2040-ce.info/development?id=i2c-display-splash
 #define DEFAULT_SPLASH \
     0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \
 	0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \

configs/PicoW/BoardConfig.h

@@ -298,7 +298,7 @@
 #define KEYBOARD_HOST_PIN_DPLUS -1
 #define KEYBOARD_HOST_PIN_5V -1
 
-// For details on this, see: https://gp2040-ce.info/#/development?id=i2c-display-splash
+// For details on this, see: https://gp2040-ce.info/development/firmware-development#i2c-display-splash
 #define DEFAULT_SPLASH \
     0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \
 	0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, \