Revert "Documentation - Docusaurus port" (#611)

Revert "Documentation - Docusaurus port (#586)" This reverts commit 00adac8.
OpenStickCommunity · Nov 5, 2023 · 63e6a24 · 63e6a24
1 parent 00adac8
commit 63e6a24
Show file tree

Hide file tree

Showing 206 changed files with 3,525 additions and 3,302 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.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
 

diff --git a/.github/ISSUE_TEMPLATE/issue---bug-report.md b/.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
 

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml
diff --git a/.gitignore b/.gitignore
@@ -12,4 +12,5 @@ lib/httpd/fsdata.c
 modules/Custom.cmake
 .idea
 cmake-*
-env.ini
+env.ini
+
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@
 
 ## Links
 
-[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)
+[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)
 
 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/site/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/docs/latency_tests/GP2040-CE_Firmware_Latency_Test_Results.xlsx) .xlsx Sheet.
 
 ## Support
 

diff --git a/configs/AlpacaOwO/BoardConfig.h b/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, \

diff --git a/configs/BentoBox/BoardConfig.h b/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/firmware-development#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, \

diff --git a/configs/Pico/BoardConfig.h b/configs/Pico/BoardConfig.h
@@ -316,7 +316,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, \

diff --git a/configs/PicoW/BoardConfig.h b/configs/PicoW/BoardConfig.h
@@ -297,7 +297,7 @@
 #define KEYBOARD_HOST_PIN_DPLUS -1
 #define KEYBOARD_HOST_PIN_5V -1
 
-// For details on this, see: https://gp2040-ce.info/development/firmware-development#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, \

diff --git a/site/static/.nojekyll → docs/.nojekyll b/site/static/.nojekyll → docs/.nojekyll
diff --git a/site/CNAME → docs/CNAME b/site/CNAME → docs/CNAME
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,53 @@
+[**Home**](README "GP2040-CE | RP2040 Gamepad Firmware Documentation")
+[**Download**](download "GP2040-CE | Download")
+**General**
+- [Introduction](introduction "GP2040-CE | Introduction")
+- [Firmware Installation](installation "GP2040-CE | Firmware Installation")
+- [Usage](usage "GP2040-CE | Usage")
+- [Hotkeys](hotkeys "GP2040-CE | Hotkeys")
+- [RGB LEDs](rgb-leds "GP2040-CE | RGB LEDs")
+- [Getting Help/Support](getting-help-support "GP2040-CE | Getting Help")
+
+**FAQs**
+
+- [General FAQ](faq "GP2040-CE | Frequently Asked Questions (FAQ)")
+- [PS4/PS5 Compatibility FAQ](faq-ps4-ps5-compatibility "GP2040-CE | PS4-PS5 Compatibility")
+
+**Web Configurator**
+
+- [Web Configurator](web-configurator "GP2040-CE | Web Configurator")
+- [Macros](macros "GP2040-CE | Macros")
+- [Add-Ons](add-ons "GP2040-CE | Web Configurator - Add-ons")
+  - [Analog](add-ons/analog.md)
+  - [BOOTSEL Button](add-ons/bootsel-button.md)
+  - [Buzzer Speaker](add-ons/buzzer-speaker.md)
+  - [Dual Directional Input](add-ons/dual-direction-input.md)
+  - [Extra Button](add-ons/extra-button.md)
+  - [Focus Mode](add-ons/focus-mode.md)
+  - [I2C Analog ADS1219](add-ons/i2c-analog-ads1219.md)
+  - [Input Reverse](add-ons/input-reverse.md)
+  - [Joystick Selection Slider](add-ons/joystick-selection-slider.md)
+  - [On-board LED](add-ons/on-board-led.md)
+  - [Player Number](add-ons/player-number.md)
+  - [PS4 Mode](add-ons/ps4-mode.md)
+  - [SNES Input](add-ons/snes-input.md)
+  - [SOCD Selection Slider](add-ons/socd-selection-slider.md)
+  - [Tilt Input](add-ons/tilt-input.md)
+  - [Turbo](add-ons/turbo.md)
+  - [USB Host Based Add-ons](add-ons/usb-host-based-add-ons.md)
+    - [PS Passthrough](add-ons/ps-passthrough.md)
+    - [Keyboard Host](add-ons/keyboard-host.md)
+  - [Wii Extensions](add-ons/wii-extensions.md)
+
+**Controller Building**
+
+- [Wiring](wiring "GP2040-CE | Wiring Guide")
+
+**Developing GP2040-CE**
+
+- [Firmware Development](development "GP2040-CE | Development")
+
+**References**
+
+- [Contribution Guide](contribution-guide "GP2040-CE | Contribution Guide")
+- [Templates](templates "GP2040-CE | Templates")
diff --git a/docs/add-ons.md b/docs/add-ons.md
@@ -0,0 +1,26 @@
+# Add-Ons Configuration
+
+This section is for custom add-ons that can be enabled to expand the functionality of GP2040-CE.  Some of these add-ons are experimental.  Please note that not all add-ons may work together.
+
+## Available Add-ons
+
+- [Analog](add-ons/analog.md)
+- [BOOTSEL Button Configuration](add-ons/bootsel-button.md)
+- [Buzzer Speaker](add-ons/buzzer-speaker.md)
+- [Dual Directional Input](add-ons/dual-direction-input.md)
+- [Extra Button Configuration](add-ons/extra-button.md)
+- [Focus Mode Configuration](add-ons/focus-mode.md)
+- [I2C Analog ADS1219](add-ons/i2c-analog-ads1219.md)
+- [Input Reverse](add-ons/input-reverse.md)
+- [Joystick Selection Slider](add-ons/joystick-selection-slider.md)
+- [On-board LED Configuration](add-ons/on-board-led.md)
+- [Player Number (X-INPUT ONLY)](add-ons/player-number.md)
+- [PS4 Mode](add-ons/ps4-mode.md)
+- [SNES Input](add-ons/snes-input.md)
+- [SOCD Selection Slider](add-ons/socd-selection-slider.md)
+- [Tilt Input](add-ons/tilt-input.md)
+- [Turbo](add-ons/turbo.md)
+- [USB Host Based Add-ons](add-ons/usb-host-based-add-ons.md)
+  - [PS Passthrough](add-ons/ps-passthrough.md)
+  - [Keyboard Host Configuration](add-ons/keyboard-host.md)
+- [Wii Extensions](add-ons/wii-extensions.md)
diff --git a/site/docs/add-ons/analog.mdx → docs/add-ons/analog.md b/site/docs/add-ons/analog.mdx → docs/add-ons/analog.md
@@ -1,11 +1,3 @@
----
-title: Analog
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # Analog
 
 ![GP2040-CE Configurator - Add-Ons Analog](../assets/images/gpc-add-ons-analog.png)

diff --git a/site/docs/add-ons/bootsel-button.mdx → docs/add-ons/bootsel-button.md b/site/docs/add-ons/bootsel-button.mdx → docs/add-ons/bootsel-button.md
@@ -1,11 +1,3 @@
----
-title: BOOTSEL Button Configuration
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # BOOTSEL Button Configuration
 
 ![GP2040-CE Configurator - Add-Ons BOOTSEL Button Configuration](../assets/images/gpc-add-ons-bootsel-button.png)

diff --git a/site/docs/add-ons/buzzer-speaker.mdx → docs/add-ons/buzzer-speaker.md b/site/docs/add-ons/buzzer-speaker.mdx → docs/add-ons/buzzer-speaker.md
@@ -1,11 +1,3 @@
----
-title: Buzzer Speaker
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # Buzzer Speaker
 
 ![GP2040-CE Configurator - Add-Ons Buzzer](../assets/images/gpc-add-ons-buzzer.png)

diff --git a/site/docs/add-ons/dual-direction-input.mdx → docs/add-ons/dual-direction-input.md b/site/docs/add-ons/dual-direction-input.mdx → docs/add-ons/dual-direction-input.md
@@ -1,11 +1,3 @@
----
-title: Dual Directional Input
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # Dual Directional Input
 
 ![GP2040-CE Configuration - Add-Ons Dual Directional Input](../assets/images/gpc-add-ons-dual-directional.png)

diff --git a/site/docs/add-ons/extra-button.mdx → docs/add-ons/extra-button.md b/site/docs/add-ons/extra-button.mdx → docs/add-ons/extra-button.md
@@ -1,11 +1,3 @@
----
-title: Extra Button Configuration
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # Extra Button Configuration
 
 ![GP2040-CE Configurator - Extra Button](../assets/images/gpc-add-ons-extra-button.png)

diff --git a/site/docs/add-ons/focus-mode.mdx → docs/add-ons/focus-mode.md b/site/docs/add-ons/focus-mode.mdx → docs/add-ons/focus-mode.md
@@ -1,10 +1,3 @@
----
-title: Focus Mode Configuration
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
 # Focus Mode Configuration
 
 ![GP2040-CE Configurator - Focus Mode](../assets/images/gpc-add-ons-focus-mode.png)

diff --git a/site/docs/add-ons/i2c-analog-ads1219.mdx → docs/add-ons/i2c-analog-ads1219.md b/site/docs/add-ons/i2c-analog-ads1219.mdx → docs/add-ons/i2c-analog-ads1219.md
@@ -1,11 +1,3 @@
----
-title: I2C Analog ADS1219
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # I2C Analog ADS1219
 
 ![GP2040-CE Configurator - Add-Ons ADS1219](../assets/images/gpc-add-ons-ads1219.png)

diff --git a/site/docs/add-ons/input-reverse.mdx → docs/add-ons/input-reverse.md b/site/docs/add-ons/input-reverse.mdx → docs/add-ons/input-reverse.md
@@ -1,11 +1,3 @@
----
-title: Input Reverse
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # Input Reverse
 
 ![GP2040-CE Configurator - Add-Ons Input Reverse](../assets/images/gpc-add-ons-input-reverse.png)

diff --git a/...ocs/add-ons/joystick-selection-slider.mdx → docs/add-ons/joystick-selection-slider.md b/...ocs/add-ons/joystick-selection-slider.mdx → docs/add-ons/joystick-selection-slider.md
@@ -1,11 +1,3 @@
----
-title: Joystick Selection Slider
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # Joystick Selection Slider
 
 ![GP2040-CE Configurator - Add-Ons Joystick Slider](../assets/images/gpc-add-ons-joystick-slider.png)

diff --git a/docs/add-ons/keyboard-host.md b/docs/add-ons/keyboard-host.md
@@ -0,0 +1,3 @@
+# Keyboard Host Configuration
+
+![GP2040-CE Configurator - Keyboard Host Configuration](../assets/images/gpc-add-ons-keyboard-host-configuration.png)
diff --git a/site/docs/add-ons/on-board-led.mdx → docs/add-ons/on-board-led.md b/site/docs/add-ons/on-board-led.mdx → docs/add-ons/on-board-led.md
@@ -1,11 +1,3 @@
----
-title: On-board LED Configuration
-# tags:
-# - 
-pagination_next: null
-pagination_prev: null
----
-
 # On-board LED Configuration
 
 ![GP2040-CE Configurator - Add-Ons On-Board LED Configuration](../assets/images/gpc-add-ons-onboard-led.png)

diff --git a/docs/add-ons/player-number.md b/docs/add-ons/player-number.md
@@ -0,0 +1,5 @@
+# Player Number (X-INPUT ONLY)
+
+![GP2040-CE Configurator - Player Number](../assets/images/gpc-add-ons-player-number.png)
+
+* `Player Number` - Choose what player number this RP2040 based device will be representing.  This is only for X-INPUT mode.
diff --git a/docs/add-ons/ps-passthrough.md b/docs/add-ons/ps-passthrough.md
@@ -0,0 +1,5 @@
+# PS Passthrough
+
+![GP2040-CE Configurator - PS Passthrough](../assets/images/gpc-add-ons-ps-passthrough.png)
+
+Enabling this add-on will allow you to use a licensed 3rd party device to authenticate off of.  This add-on requires that you have something like the ![USB Passthrough Board](https://github.com/OpenStickCommunity/Hardware/tree/main/USB%20Passthrough%20Board) or a board with a USB passthrough port on it already.  If you have passthrough enabled you can turn off the above `PS4 Mode` add-on as the two will not work together.  Please also ensure that under the `Settings` section you have chosen PS4 mode and picked if you want the GP2040-CE unit to function as a controller or as a fightstick.