Armchair-Heavy-Industries · HumbleDeer · Dec 11, 2023 · Dec 11, 2023 · Dec 11, 2023 · Dec 19, 2023
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -0,0 +1,62 @@
+name: Deploy MkDocs to Pages
+on:
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Install Material for MkDocs
+        run: pip install mkdocs-material
+      - name: Build MkDocs
+        run: mkdocs build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with: 
+          path: ./site     
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v3
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .DS_Store
 .vscode/
 out/
+docs/site/
diff --git a/.nojekyll b/.nojekyll
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/BOM.md b/docs/BOM.md
diff --git a/docs/DFA_MOD_License.md b/docs/DFA_MOD_License.md
diff --git a/docs/README.md b/docs/README.md
@@ -8,113 +8,3 @@ Project lead: [DW-Tas](https://github.com/DW-Tas)
 [![Join me on Discord](https://discord.com/api/guilds/1029426383614648421/widget.png?style=banner2)](https://discord.gg/armchairengineeringsux)
 
 <img src='assets/images/full_assembly.png' width=600 />
-
-## What's new
-`Xol-Toolhead Release 2023-12-21`
-* Quality of life improvements
-  * Cable routing holes are now on both sides of the toolhead
-  * Cable routing holes can now fit MF3.0 commonly used on hotends
-  * Awkward M3 Heatset insert replaced with easier to install M3 hex nut for front extruder mount connection
-  * Rapido hotend mounting points rotated to improve wire routing
-* Minimal BOM change
-  * 1x M3 Hex Nut replaces 1x M3 Heatset Insert
-  * 1x M3x6 BHCS replaces 1x M3x8 BHCS
-* Reworked Extruder mount to Hotend mount interface
-  * Old Hotend mounts will not work with new Extruder mounts and vice-versa
-
-`Xol-Toolhead Release 2023-09-15`
-* Modular approach to hotend mounts and extruders
-  * Hotend mounts and extruder mounts are now separate parts
-  * Extruder mounts incorporate the old Xol-Carriage or TAP adapter plates (same number of printed parts overall)
-  * "Xol with bones" option: Add some screws for extra rigidity in the hotend mount
-* Minimal BOM change
-  * 1x M3x8 BHCS
-  * 1x M3 Heatset
-  * Optional "bones"
-    * 2x M2x30 SHCS
-    * 2x M2 Heatset
-* Xol-Carriage update
-  * Stronger belt clips
-  * bigger probe cable channel with cable tie slot
-
-`Xol-Toolhead Release 2023-07-14`
-* Standardised hotend mounts around the Voron Design CW2/TAP carriage bolt hole pattern.
-  * This approach reduces the number of hotend mounts and ducts by half - You don't have to search for TAP or non-TAP and we don't have to maintain twice as many parts
-* Xol-Carriage
-  * A new carriage built for Xol-Toolhead
-  * Uses metal pins and a belt clip to secure the belts instead of having them squashed between mgn9/12 carriage and toolhead carriage
-  * Improved serviceability - remove the toolhead from the carriage without disassembly in the printer. Unless you use Voron TAP or refuse to buy M2.5 hardware for Xol Carriage. Buy the m2.5 hardware, it's worth it trust us.
-  * Modular probe mounting system - change probes without changing the whole carriage _`*Except for KlickyNG`_
-* These carriage changes mean you can use any carriage that a Stealthburner bolts onto. (Our Xol-Carriage, or the stock voron carriage even.)
-
-## Supported hardware
-### Hotends
-* Rapido
-* DropEffect XG
-* DropEffect NeXt-G `when released`
-* Red Lizard K1-UHF
-* Dragon UHF/Mini
-* Dragon ST/HF
-* Dragon Ace
-* Revo Voron
-* NF-Crazy (*without duct LEDs)
-
-### Extruders
-* Sherpa Mini
-* Annex Double Folded Ascender
-* Galileo G2SA
-* Escapement
-* Vz-Hextrudort-Low
-* LGX-Lite
-* Orbiter v2.0
-
-### Probes
-* PCB Klicky
-* Klicky
-* KlickyNG
-* Beacon
-* Euclid
-* Voron Design TAP `For RC8+ we suggest to use m3x50 BHCS instead of SHCS`
-
-### X-Rail/Belts
-* MGN12H - 6mm Belts
-* MGN9H - 6mm Belts
-* MGN9H - 9mm Belts
-
-### Front Idlers
-Xol-Toolhead can colide with the stock voron front idlers for Trident and 2.4 when the toolhead is in the front corners of the build area. This can cause also issues with the homing sequence when homing X if the toolhead is at the front of the gantry on Y. <br/>
-Fully compatible idlers:
-* clee's [BFI (Beefy Front Idlers)](https://github.com/clee/VoronBFI)
-* Ramalama2's [Front Idlers](https://github.com/Ramalama2/Voron-2-Mods/tree/main/Front_Idlers)
-
-## We've made some instructions for printing and assembly.
-They took ages to make, please read them.
-* [Bill of Materials (BOM)](BOM.md)
-* [Printing parts](printing.md)
-* [Carriage assembly](xol_carriage_assembly.md)
-* [Toolhead assembly](toolhead_assembly.md)
-
-
-## Acknowledgements
-* [DW-Tas](https://github.com/DW-Tas) for giving Xol the giant refresh it needed.
-* [CorvidBuilds](https://github.com/CorvidBuilds) for Xol1 and Xol2, the predecessors to this project.
-* [Long/Mandryd](https://github.com/mandryd/VoronUsers/tree/master/printer_mods/Long/Mantis_Dual_5015) for the Mantis toolhead.
-* [Derpimus](https://github.com/lraithel15133) for the exegesis, some CAD work, feedback, and just being a rad dude.
-* [KayosMaker](https://github.com/KayosMaker) for the CAN board mounts and spacers.
-* [JosAr](https://github.com/jlas1/Klicky-Probe) for Klicky.
-* [WhoppingPochard](https://github.com/tanaes) and [VinnyCordeiro](https://github.com/VinnyCordeiro/) for PCB Klicky.
-* [Nionio6915](https://github.com/nionio6915/Euclid_Probe) for Euclid.
-* [VoronDesign](https://github.com/VoronDesign) for this particular CoreXY flavor.
-* [AnnexEngineering](https://github.com/Annex-Engineering) for the Sherpa Mini and Double Folded Ascender extruders, and the K3 that influenced the air management of the ducts. And also for giving access to an early revision of the DFA so it could be adapted for this toolhead.
-* [clee](https://github.com/clee), you know what you did.
-
-<br/><br/><br/><br/>
-
-This work is licensed under a
-[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].
-
-[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]
-
-[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/
-[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png
-[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg
diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png
diff --git a/docs/xol_carriage_assembly.md → docs/carriage/assembly.md b/docs/xol_carriage_assembly.md → docs/carriage/assembly.md
@@ -1,4 +1,10 @@
-# Xol Carriage Assembly
+---
+title: Carriage assembly
+description: Assembly instructions for the Xol Carriage
+---
+
+# Assembly instructions
+
 ![Xol Carriage Image](assets/images/xol_carriage/xol_carriage.png)
 
 

diff --git a/docs/carriage/bom.md b/docs/carriage/bom.md
@@ -0,0 +1,31 @@
+---
+title: Carriage BOM
+description: Bill Of Materials and required parts for the Xol Carriage
+---
+
+# Bill Of Materials
+
+## Required Hardware
+
+| Qty | Item              | Notes                                                                                                    |
+| --- | ----------------- | -------------------------------------------------------------------------------------------------------- |
+| 5   | M3 Heatset Insert | Standard Voron spec: 5mm Outer Diameter x 4mm Length                                                     |
+| 6\* | M3 x 6 BHCS       | `Only 4 for MGN9H carriage` <br/>2x MGN12H carriage rear<br/>2x Carriage front<br/>2x probe module                         |
+| 8\* | M3 x 8 SHCS       | `only 4 for MGN12H carriage` <br/>4x Join carriage front to carriage rear<br/>4x MGN9H carriage mounting |
+| 4\* | M3 Hex Nut        | `Only 2 for MGN9H carriage` <br/>4x Carriage rear                                                        |
+| 2\* | M3 x 26 Pin       | Belt mounting system for 6mm belts. 24, 25 and 26mm pins have all been tested. 26mm is the strongest if pushing limits |
+| 2\* | M3 x 30 Pin       | Belt mounting system for 9mm belts                                                                       |
+
+* See [Probe Hardware](#probe-hardware) below for footnotes on M3 screws when using a Voron Design TAP RC8+.
+
+## Optional Hardware
+
+| Qty | Item              | Notes                                                   |
+| --- | ----------------- | ------------------------------------------------------- |
+| 2   | M3 Heatset insert | If not using m2.5 heatsets for toolhead feet attachment |
+
+## Probe Hardware
+
+Follow probe instructions for required hardware. Where possible, self tapping screws have been replaced with heatset hardware, usually M2.
+
+If using Voron Design TAP RC8+ it is recommended to replace the two M3 x 50 **SHCS** with M3 x 50 **BHCS** to improve build plate clearance.
diff --git a/docs/carriage/index.md b/docs/carriage/index.md
@@ -0,0 +1,6 @@
+---
+title: Carriage guide
+description: Documentation relating to the Carriage within the Xol ecosystem
+---
+
+# Xol carriage