Merge pull request #2 from Open-Shock/feature/mkdocs

Feature/mkdocs

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Check for Github Actions version updates (for CI/CD)
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/ci-master.yml

@@ -0,0 +1,33 @@
+on:
+  push:
+    branches:
+      - master
+      - feature/mkdocs
+
+name: ci-master
+
+env:
+  SHOCKLINK_API_URL: api.shocklink.net
+  SHOCKLINK_FW_VERSION: master-${{ github.sha }}
+
+jobs:
+
+  # Copied verbatim from https://docs.platformio.org/en/stable/integration/ci/github-actions.html
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/pip
+          key: ${{ runner.os }}-arch
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install MkDocs
+        run: pip install mkdocs-material

docs/account/index.md

@@ -0,0 +1 @@
+# index

docs/account/sign-up.md

@@ -0,0 +1,5 @@
+---
+
+---
+
+# Sign up

docs/contributing/contributing.md

@@ -0,0 +1,2 @@
+
+# Contributing

Hardware/Buy.md → docs/hardware/Buy.md

@@ -1,11 +1,7 @@
 ---
-title: Hardware: Buy
-description: Where can I buy Hardware to DIY my own shocker and box/board?
-published: true
-date: 2023-09-19T16:41:01.688Z
-tags: diy, hardware, esp32
-editor: markdown
-dateCreated: 2023-09-17T13:51:13.394Z
+tags:
+  - hardware
+  - diy
 ---
 
 My best efforts to list ali express links to current parts to DIY build your own ESP-32 board, where to buy shockers from and what to look out for.
@@ -22,11 +18,16 @@ Read more on each part below.
 ## ESP-32
 Genuinely any ESP-32 should work if it has enough flash memory (4MB or more). ESP-8266 are currently not supported.
 
-> I recommend getting the **CP2104 drive Type-C** for USB Type-C as a connector. Also fits the 3D print better.
-In addition I recommend you buy atleast 2-3 of those, for the reason of up to 20% of those micro controllers are dead on arrival. So to avoid having a bad board and needing to wait 3 more weeks for you order, buy 2-3 of them at once.
-{.is-info}
+!!! info
+
+    We recommend getting the **CP2104 drive Type-C** for USB Type-C as a connector. This board also fits the 3D print better.
+
+!!! warning
+
+    We also recommend buying at least 2-3 of these boards. Up to 20% of them are dead-on-arrival.
 
-+ Global: https://aliexpress.us/item/2251832671740023.html
+
++ Global: [https://aliexpress.us/item/2251832671740023.html](https://aliexpress.us/item/2251832671740023.html)
 
 
 ## 433 MHz RF Antenna
@@ -41,12 +42,14 @@ There is two shocker protocol supported currently. One of them is a older shocke
 
 For protocol specifications see here: https://github.com/Shock-Link/ShockLink-Hardware
 
-> You cannot directly order Shockers to Germany, they will get denied for import by the German "Zoll". Alternatively proxy your parcel over the Netherlands or Luxembourg.  
-The reason for the Zoll denying import is, that the Shocker is made for dogs. Using shock collars on animals is considered illegal by EU law, but only germany seems to care about imports.  
-{.is-warning}
+!!! warning
 
-> Promotion: LucHeart on discord sells Shockers and fully assembled ESP-32's to germany and surrounding countries. More info here: [WIP]
-{.is-info}
+    You cannot directly order Shockers to Germany, they will get denied for import by the German "Zoll". Alternatively proxy your parcel over the Netherlands or Luxembourg.  
+    The reason for the Zoll denying import is, that the Shocker is made for dogs. Using shock collars on animals is considered illegal by EU law, but only germany seems to care about imports.  
+
+!!! info
+
+    Promotion: LucHeart on discord sells Shockers and fully assembled ESP-32's to germany and surrounding countries. More info here: [WIP]
 
 + Luxembourg / Generally good store: https://aliexpress.us/item/3256804060226907.html
 + Netherlands: https://aliexpress.us/item/3256805172752011.html (Seems to be the same seller and offer as the US one)

Hardware/Assembly.md → docs/hardware/diy/building.md

@@ -1,12 +1,3 @@
----
-title: Hardware: Assembly
-description: DIY Assemble your ESP-32 and Antenna
-published: true
-date: 2023-09-19T16:34:29.809Z
-tags: guide, diy
-editor: markdown
-dateCreated: 2023-09-18T02:26:29.397Z
----
 
 This guide mainly focuses on the parts listed in the [Hardware Buy guide](/Hardware/Buy).
 
@@ -21,3 +12,4 @@ See the [Hardware Buy guide here](/Hardware/Buy). For the board/ESP-32 assembly
 
 
 ## Figuring out the PINs
+

docs/hardware/diy/prerequisites.md

@@ -0,0 +1,2 @@
+
+# DIY

docs/hardware/pishock/custom-v1.md

@@ -0,0 +1,36 @@
+---
+tags:
+  - hardware
+  - vendor
+  - pishock
+---
+
+# Custom PCB v1 (current)
+
+!!! danger "Extreme price point"
+
+    We strongly discouraging buying products from this vendor due to their extremely high price points. 
+
+!!! success "Fully compatible"
+
+    This product is fully compatible with OpenShock.
+
+First seen in the wild on `2023-09-19`.
+
+## Internals
+- Espressif ESP32-WROOM-32D
+- On-board radio chip
+
+## Pinout
+- Use PIN 14 for transmitting.
+
+## Flashing
+
+This board is compatible with the flash tool.
+
+## Media
+
+![Pishock Custom PCB v1 - Case](/static/pishock-custom-v1/case.jpg)
+![Pishock Custom PCB v1 - Case back](/static/pishock-custom-v1/case-back.jpg)
+![Pishock Custom PCB v1 - PCB Front](/static/pishock-custom-v1/pcb-front.jpg)
+![Pishock Custom PCB v1 - PCB Back](/static/pishock-custom-v1/pcb-back.jpg)

docs/hardware/pishock/lite.md

@@ -0,0 +1,24 @@
+---
+tags:
+  - hardware
+  - vendor
+  - pishock
+---
+
+# Pishock Lite (2021 Q3)
+
+!!! danger "Extreme price point"
+
+    We strongly discouraging buying products from this vendor due to their extremely high price points. 
+
+!!! success "Fully compatible"
+
+    This product is fully compatible with OpenShock.
+
+## Internals
+
+## Pinout
+
+## Media
+
+We currently do not have any media of the Pishock Lite that we have permission to use. Do you own this device and are you willing to let us use your photographs? Then [contact us via Discord](https://discord.gg/AHcCbXbEcF).

docs/hardware/pishock/plus.md

@@ -0,0 +1,24 @@
+---
+tags:
+  - hardware
+  - vendor
+  - pishock
+---
+
+# Pishock Plus (2021 Q1)
+
+!!! danger "Extreme price point"
+
+    We strongly discouraging buying products from this vendor due to their extremely high price points. 
+
+!!! failure "Not compatible"
+
+    This product is not compatible with OpenShock.
+
+## Internals
+
+This device is based on the [Raspberry Pi Zero W](https://www.raspberrypi.com/products/raspberry-pi-zero-w/), which is not compatible with OpenShock.
+
+## Media
+
+We currently do not have any media of the Pishock Plus that we have permission to use. Do you own this device and are you willing to let us use your photographs? Then [contact us via Discord](https://discord.gg/AHcCbXbEcF).

docs/index.md

@@ -0,0 +1,15 @@
+
+# OpenShock
+
+Welcome to OpenShock! We're proud to present our fully open-source software solution, compatible with off-the-shelf hardware to get you started in the world of shocking!
+
+## Getting started
+
+Head over to the Quickstart to get started:
+
+- [Getting shocked](quickstart/getting-shocked/hardware)
+- [Shocking others](quickstart/shocking-others/create-account)
+
+## Community
+
+Like what you see? Join us [over on Discord!](https://discord.gg/AHcCbXbEcF)

docs/quickstart/getting-shocked/choosing-a-server.md

@@ -0,0 +1,6 @@
+---
+tags:
+    - quickstart
+---
+
+# Choosing a server

docs/quickstart/getting-shocked/sourcing-hardware.md

@@ -0,0 +1,18 @@
+---
+tags:
+  - quickstart
+  - getting-shocked
+---
+
+# Sourcing hardware
+
+To get shocked, you'll need two things:
+
+- An **OpenShock Controller**;
+- One or more off-the-shelf **shockers**.
+
+## Controller
+
+For absolute beginners, it's easiest to head over to our [Buying Guide](hardware/buy/).
+
+If you have experience with soldering and have the needed equipment, head over to [our DIY guide on building your own Controller](hardware/diy/).

getting-started.md → docs/quickstart/getting-started.md

@@ -3,7 +3,6 @@ title: Getting Started
 description: 
 published: true
 date: 2023-08-08T03:47:42.224Z
-tags: 
 editor: markdown
 dateCreated: 2023-08-08T02:58:45.555Z
 ---

docs/quickstart/select-server.md

@@ -0,0 +1,5 @@
+# Select a server
+
+OpenShock is a collection of software projects that together provide you with the 
+
+To begin on your OpenShock yourney, either as shocker or shockee, you need to choose an OpenShock server where you will create your account, create share links and give others access.

docs/quickstart/shocking-others/create-account.md

@@ -0,0 +1 @@
+# Create account

docs/quickstart/terminology.md

@@ -0,0 +1,7 @@
+---
+tags:
+  - quickstart
+---
+
+# Terminology
+

docs/quickstart/welcome.md

@@ -0,0 +1,16 @@
+# Welcome
+
+If you've found yourself here, chances are you're either looking to get shocked, or shock a friend or partner! We've written this quickstart guide to help you get shocking as fast as possible.
+
+## Quickstart
+
+To get started with OpenShocks, you need three things:
+
+1. A public or private OpenShock server;
+    - We recommend the [ShockLink.net](https://shocklink.net) public OpenShock instance.
+    - If you want to host it yourself, see [Selfhosting](/selfhosting).
+2. A ShockLink Controller:
+    - This is a small piece of hardware, usually connected by USB-C.
+    - For buying, see [Hardware/Buy](/hardware/buy/).
+    - For DIY, see [Hardware/DIY](/hardware/diy/).
+3. One or more shock collars!