Skip to content

Commit

Permalink
Moving more documentation to their respective new pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@HumbleDeer
HumbleDeer committed Dec 19, 2023
1 parent 2070783 commit 636c19b
Show file tree
Hide file tree
Showing 5 changed files with 148 additions and 110 deletions.
97 changes: 0 additions & 97 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,100 +9,3 @@ Project lead: [DW-Tas](https://github.com/DW-Tas)

<img src='assets/images/full_assembly.png' width=600 />

## What's new
`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
44 changes: 34 additions & 10 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,49 @@ The Xol Toolhead was designed with modularity, low barrier of entry, ease of mai

---

We have left the Mantis carriage behind, and thus are now just Xol-sans-Mantis.
*Don't worry, it's still ugly, we couldn't fix that.*
We have left the Mantis carriage behind, and thus are now just Xol-sans-Mantis.
*Don't worry, it's still ugly, we couldn't fix that.*

## Licensing

A disclaimer regarding the printed parts and models that provide support for the [Annex Engineering Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder) extruder.
## Atrocity

The custom parts that enable support for the [Annex Engineering Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder) are derived from designs by Annex Engineering, and are therefor bound to adhering by their license. These parts are accordingly licensed under the same license as the Annex Engineering design and parts.
"Atrocity" is a local meme.

This license agreement can be read through in the [Annex Engineering License Agreement](https://github.com/Annex-Engineering/ANNEX-Engineering-License-Agreement)
!["commit atrocity every day" quoted from Discord](https://media.discordapp.net/attachments/1034245907622924348/1062902237329895444/image.png)

## Join us

Join us on discord, where an avid and enthusiastic community gathers for *true atrocity* [^1](#Atrocity)

[![Join me on Discord](https://discord.com/api/guilds/1029426383614648421/widget.png?style=banner2)](https://discord.gg/armchairengineeringsux)

## Atrocity
## Acknowledgements

"Atrocity" is a local meme.
* [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.

!["commit atrocity every day" quoted from Discord](https://media.discordapp.net/attachments/1034245907622924348/1062902237329895444/image.png)
## Licensing

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]

---

A disclaimer regarding the **printed parts and models** that provide support for the [Annex Engineering Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder) extruder.

The custom parts that enable support for the [Annex Engineering Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder) are **derived from designs by Annex Engineering**, and are therefor bound to adhering by **their license**. These parts are accordingly licensed under the same license as the Annex Engineering design and parts.

This license agreement can be read through in the [Annex Engineering License Agreement](https://github.com/Annex-Engineering/ANNEX-Engineering-License-Agreement)

[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
61 changes: 61 additions & 0 deletions docs/supported-hardware.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Supported hardware
description: A list of hot ends, extruders and other printer toolhead parts that are currently compatible with the Xol toolhead and carriage through the provided parts and components
---

# Supported hardware

This list provides a comprehensive yet incomplete summary of the hardware parts and setups that are deemed compatible with the currently available Xol toolhead and carriage parts and components.

## Hotends

* Phætus [Rapido](https://www.phaetus.com/products/rapido-hotend)
* DropEffect [XG](https://www.dropeffect.com/products/xg-hotend)
* DropEffect NeXt-G `when released`
* Haldis 3D Red Lizard K1-UHF
* Phætus [Dragon UHF/Mini](https://github.com/Phaetus/Dragon-UHF)
* Phætus [Dragon ST](https://github.com/Phaetus/Dragon-ST)
* Phætus [Dragon HF](https://github.com/Phaetus/Dragon-HF)
* Trianglelab [Dragon Ace](https://www.trianglelab.net/products/dragon-ace%E2%84%A2-hotend)
* E3D [Revo Voron](https://e3d-online.com/products/revo-voron)
* Mellow3D [NF-Crazy](https://github.com/Mellow-3D/NF-Crazy) (*without duct LEDs)

## Extruders

* Annex Engineering [Sherpa Mini](https://github.com/Annex-Engineering/Sherpa_Mini-Extruder)
* Annex Engineering [Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder)
* [Galileo G2SA](https://github.com/JaredC01/Galileo2) (Standalone)
* Escapement
* [Vz-Hextrudort-Low](https://github.com/VzBoT3D/Vz-HextrudORT)
* Bondtech [LGX-Lite](https://www.bondtech.se/product/lgx-lite-large-gears-extruder/)
* [Orbiter V2.0](https://www.orbiterprojects.com/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-axis rail & belts

The following combinations of linear rail and timing belt are currently supported:

* MGN12H - 6mm Belts
* MGN9H - 6mm Belts
* MGN9H - 9mm Belts

All belts are assumed to be Gates 2GT specification belts

## Front Idlers

!!! note "Voron 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.

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)
33 changes: 33 additions & 0 deletions docs/updates.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Update log
description: Release update logs documenting changes, additions, removals and fixes.
---

# Update log

## `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.)
23 changes: 20 additions & 3 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,25 @@ theme:
logo: assets/images/logo.png
favicon: assets/images/logo.png
icon:
admonition:
# Default/stock Material for MkDocs icons
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
repo: fontawesome/brands/github
next: xbox_button_right
previous: xbox_button_left
close: xbox_button_x

palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
Expand All @@ -22,7 +36,7 @@ theme:
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
Expand All @@ -40,9 +54,12 @@ theme:
- toc.follow

markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- docs/theme/.icons
- docs/theme/.icons

0 comments on commit 636c19b

Please sign in to comment.