Removing docs and pointing to website (#315)

Author: ejsears

CHANGELOG.md

@@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - The `afc-debug.sh` script will now also upload `AFC.log` files for assistance during troubleshooting.
 
+### Changed
+- All documentation is now available on our website at https://armoredturtle.xyz/docs/.
+
 ## [2025-04-09]
 
 ### Added

README.md

@@ -65,267 +65,9 @@ This can be accomplished by commenting out the following lines in your `printer.
 
 Once the plugin is updated, please uncomment the lines in your `printer.cfg` file (if applicable).
 
-## Configuration (Automated)
+## Documentation
 
-The `install-afc.sh` script will automatically install the majority of the plugin for you.
-
-Prior to starting Klipper, please review the configuration located at `~/printer_data/config/AFC/AFC_Turtle_(n).cfg` and ensure all pins are correct for your specific hardware.
-
-Additionally, review the following files for any changes that may be required:
-
-1. `~/printer_data/config/AFC/AFC.cfg`
-2. `~/printer_data/config/AFC/AFC_Macro_Vars.cfg`
-3. `~/printer_data/config/AFC/AFC_Turtle_1.cfg`
-
-Review information in [mandatory configuration changes](README.md#mandatory-configuration-changes-all) section
-
-## Installation & Configuration (Manual)
-
-To manually install and configure the plugin, you can use the following commands:
-
-```bash
-cd ~
-git clone https://github.com/ArmoredTurtle/AFC-Klipper-Add-On.git
-cd AFC-Klipper-Add-On
-ln -sf ~/AFC-Klipper-Add-On/extras/*.py ~/klipper/klippy/extras/
-mkdir -p ~/printer_data/config/AFC
-cp -R ~/AFC-Klipper-Add-On/config/* ~/printer_data/config/AFC/
-```
-
-Next, please copy the appropriate `AFC_Hardware.cfg` template file from `~/AFC-Klipper-Add-On/templates` to `~/printer_data/config/AFC`
-and modify the file to match your hardware configuration. Ensure you rename the file properly based on the selected board type to `AFC_Hardware.cfg`.
-
-You should also copy the `AFC_Turtle_1.cfg` template file from `~/AFC-Klipper-Add-On/templates` to `~/printer_data/config/AFC` and modify this file to match your hardware configuration.
-
-Finally, review and update the following files as needed for your configuration.
-
-1. `~/printer_data/config/AFC/AFC.cfg`
-2. `~/printer_data/config/AFC/AFC_Macro_Vars.cfg`
-3. `~/printer_data/config/AFC/AFC_Hardware.cfg`
-4. `~/printer_data/config/AFC/AFC_Turtle_1.cfg`
-
-## Moonraker configuration
-
-To enable the AFC plugin in Moonraker, you should add the following lines to your `moonraker.conf` file:
-
-```cfg
-[update_manager afc-software]
-type: git_repo
-path: ~/AFC-Klipper-Add-On
-origin: https://github.com/ArmoredTurtle/AFC-Klipper-Add-On.git
-managed_services: klipper
-primary_branch: main
-is_system_service: False
-info_tags:
-    desc=AFC Klipper Add On
-```
-## Initial Startup Guide
-If this is your first time setting up a Box Turtle please follow the [initial startup guide](https://github.com/ArmoredTurtle/BoxTurtle/blob/main/Initial_Startup.md#install-the-afc-klipper-add-on)
-## Mandatory Configuration Changes (All)
-
-Prior to operation, the following checks / updates **MUST** be made to your system:
-
-1.  Update the following values in the `~/printer_data/config/AFC/AFC_Hardware-{board}.cfg` file:  
-    *default name with AFC-lite will be AFC_Hardware-AFC.cfg*
-
-    - tool_stn: This value is the length from your toolhead sensor to nozzle, if `tool_end` is defined then distance is from this sensor
-    - tool_stn_unload: This value is the amount to unload from extruder when doing a filament change.
-
-2.  Update the following in the `~/printer_data/config/AFC/AFC_Turtle_{n}.cfg` file:  
-    *for systems with a single unit, the file will show as `AFC_Turtle_1.cfg` addtional units with be 2, 3 etc.*
-
-    - afc_bowden_length: This value is the length from your hub to your toolhead sensor
-
-3.  Verify that `pin_tool_start` is set to the correct pin for your toolhead sensor. If you are using an existing filament sensor as your toolhead sensor make sure you comment out any filament sensor sections in your `printer.cfg` file.
-
-4.  If you are using any of the built-in macros, the variables in the `~/printer_data/config/AFC/AFC_Macro_Vars.cfg` file
-    must also be modified to match your configuration for your system.
-
-        Required variables to verify and update if necessary for the following default macros
-        - tool_cut:
-          - variable_retract_length
-          - variable_cut_direction
-          - variable_pin_loc_xy
-          - variable_pin_park_dist
-          - variable_cut_move_dist
-        - park:
-          - variable_park_loc_xy
-        - poop:
-          - variable_purge_loc_xy
-        - kick:
-          - variable_kick_start_loc
-          - variable_kick_direction
-        - wipe
-          - variable_brush_loc
-          - variable_y_brush
-        - form_tip
-          Variables to update for tip forming are in `~/printer_data/config/AFC/AFC.cfg`
-          - cooling_tube_position
-          - cooling_tube_length
-
-5.  If you would like to use your own macro instead of the provided macros, make sure to update the command with your custom macro in `~/printer_data/config/AFC/AFC.cfg`  
-     ex. If using custom park macro, change `park_cmd` from `AFC_PARK` to your macro name
-
-**Failure to update these values can result in damage to your system**
-
-## Optional Configuration Changes
-
-If you use a Turtleneck v2, you can enable the buffer indicator LED by adding the following lines to your `AFC.cfg` file:
-
-```cfg
-led_buffer_advancing: 0,0,1,0
-led_buffer_trailing: 0,1,0,0
-led_buffer_disable: 0,0,0,0.25
-```
-
-If using a hub that is not located in the box turtle the following value needs to be updated for each stepper
-
-- dist_hub: This value the the length between the lanes extruder and the hub, this does not have to be exact and is better to figure the length and then minus about 40mm
-
-If using snappy hub cutter update the following values:
-
-- cut: change to True
-- cut_dist: update to the value that you would like to cut off the end, this may take some tuning to get right
-
-### Buffer configuration - Manual
-
-If you are using a buffer such as the Turtleneck, Turtleneck v2 or Annex Belay, and you installed the software manually, you may need to make a couple of additional changes.
-
-You should add the following block to your `AFC_Turtle_1.cfg` file based on the type of buffer you are using.
-
-**NOTE** The `pin` value should be set to the pin that the buffer is connected to on your board.
-
-### Hub configuration - Manual
-
-If direct loading to an extruder is desired the following lines need to be added to the [AFC_stepper <lane>] of choice.
-
-```cfg
-hub: direct
-```
-
-When using this will cause the spool to automatically load to the extruder. There should be no Hub in-between that lane and the extruder.
-Using 'direct' will disable calabrations for that lane.
-
-#### Turtleneck
-
-```cfg
-[AFC_buffer TN]
-advance_pin:     # set advance pin
-trailing_pin:    # set trailing pin
-multiplier_high: 1.05   # default 1.05, factor to feed more filament
-multiplier_low:  0.95   # default 0.95, factor to feed less filament
-velocity: 100
-```
-
-Turtleneck v2
-
-```cfg
-[AFC_buffer TN2]
-advance_pin: !turtleneck:ADVANCE
-trailing_pin: !turtleneck:TRAILING
-multiplier_high: 1.05   # default 1.05, factor to feed more filament
-multiplier_low:  0.95   # default 0.95, factor to feed less filament
-led_index: Buffer_Indicator:1
-velocity: 100
-
-[AFC_led Buffer_Indicator]
-pin: turtleneck:RGB
-chain_count: 1
-color_order: GRBW
-initial_RED: 0.0
-initial_GREEN: 0.0
-initial_BLUE: 0.0
-initial_WHITE: 0.0
-```
-
-Finally, add `buffer: <buffer_name>` to either your `AFC_extruder`, `AFC_stepper`, or `AFC_<unit_type>` sections in `AFC_Turtle_(n).cfg` files. For example, if you are using the Turtleneck v2, you would add the following line:
-
-Using this config, buffer will be used for every unit that uses this extruder
-
-```cfg
-[AFC_extruder extruder]
-buffer: TN2
-```
-
-Using this config, buffer will be used for every lanes that uses this unit
-
-```cfg
-[AFC_BoxTurtle Turtle_1]
-buffer: TN2
-```
-
-Using this config, buffer will be used for just the lanes the buffers is assigned to, this will override anything set in extruder/unit sections
-
-```cfg
-[AFC_stepper lane1]
-buffer: TN2
-```
-
-Additional information about the buffer configuration and operation can be found in the [AFC_buffer.md](./docs/AFC_buffer.md) file.
-
-## Automatic Calibration
-
-Call `AFC_CALIBRATION` in your gui of choice and follow the prompts to calibrate your AFC system.  
-_distances will be calibrated to have ~1 short move after the move distance_  
-**All values will be automatically updated in the proper config sections after calibration**
-
-If using a hub different from the stock set up `hub_clear_move_dis` under AFC unit may need to be increased/decreased to match your setup, default `50mm`.
-
-For additional information and the steps for manual calibration, can be found in [Calibration.md](./docs/Calibration.md)
-
-## Troubleshooting
-
-A debug script is available to be run that can assist the Armored Turtle support team on their Discord channel. To run the script, simply use the following commands:
-
-```bash
-cd ~/AFC-Klipper-Add-On/troubleshooting
-./afc-debug.sh
-```
-
-This script will collect some basic information about your system to include Klipper logs, device information, CAN network information, and your AFC
-configuration files. This information will be uploaded to termbin.com and the resulting link can be used to share this information with the Armored Turtle team.
-
-Debug information about the respooler system can be found by visiting the following URL in your browser:
-
-`{ip address}/printer/afc/status`
-
-## LEDs not displaying correct color
-
-If your leds are not displaying the correct color update the following value under your `AFC_led` section in `~/printer_data/config/AFC/AFC_Turtle_(n).cfg` file.
-
-- color_order: change to match the color order for you leds. Different color orders are: RGB, RGBW, GRB, GRBW
-
-## Filament pulling past extruder during unloads
-
-During unloads if your filament retracts too much and goes past the lanes extruder then decrease your `afc_bowden_length` value in `~/printer_data/config/AFC/AFC.cfg` file
-
-## Timer too close (TTC) error
-
-If you keep getting TTC errors start by adding the following to `AFC/AFC.cfg` file under `[AFC]` section
-
-- `trsync_update: True`
-
-## Layer shift when using cut macro
-
-If you notice a layer shift occurs while using the cut macro, setting a higher stepper current while cutting has shown to help with this.
-Update and uncomment the following values in `AFC/AFC_Macr_Vars.cfg` file
-
-- variable_cut_current_stepper_x - start with ~1.7-1.8A
-- variable_cut_current_stepper_y - start with ~1.7-1.8A
-- Only needed if cutting action is along the z - variable_cut_current_stepper_z
-
-Make sure your stepper names are updated for variables: `variable_cut_current_stepper_x, variable_cut_current_stepper_y, variable_cut_current_stepper_z`
-
-## Removing Plugin
-
-To remove the plugin, you can use the following commands:
-
-```bash
-cd ~/AFC-Klipper-Add-On
-./install-afc.sh
-```
-
-Once the installation program starts, please select the option to remove the plugin.
+Further documentation on the plugin, it's various commands and configuration references can be found [here](https://armoredturtle.xyz/docs/).
 
 ## Support