3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Rename Documents 

Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
This commit is contained in:
Yifei Ding 2021-11-20 23:23:56 -08:00 committed by Kevin O'Connor
parent 85667649d1
commit a1af78cb83
10 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/beaglebone.md → docs/Beaglebone.md
View File

2
docs/Config_Changes.md
View File

@ -308,7 +308,7 @@ that command.
20190628: All configuration options have been removed from the 20190628: All configuration options have been removed from the
[skew_correction] section. Configuration for skew_correction [skew_correction] section. Configuration for skew_correction
is now done via the SET_SKEW gcode. See skew_correction.md is now done via the SET_SKEW gcode. See [Skew Correction](Skew_Correction.md)
for recommended usage. for recommended usage.
20190607: The "variable_X" parameters of gcode_macro (along with the 20190607: The "variable_X" parameters of gcode_macro (along with the

8
docs/Config_Reference.md
View File

@ -1112,8 +1112,8 @@ Printer Skew Correction. It is possible to use software to correct
printer skew across 3 planes, xy, xz, yz. This is done by printing a printer skew across 3 planes, xy, xz, yz. This is done by printing a
calibration model along a plane and measuring three lengths. Due to calibration model along a plane and measuring three lengths. Due to
the nature of skew correction these lengths are set via gcode. See the nature of skew correction these lengths are set via gcode. See
[skew correction](skew_correction.md) and [Skew Correction](Skew_Correction.md) and
[command reference](G-Codes.md#skew-correction) for details. [Command Reference](G-Codes.md#skew-correction) for details.
``` ```
[skew_correction] [skew_correction]
@ -3727,7 +3727,7 @@ TSLl401CL Based Filament Width Sensor. See the
### [hall_filament_width_sensor] ### [hall_filament_width_sensor]
Hall filament width sensor (see Hall filament width sensor (see
[Hall Filament Width Sensor](HallFilamentWidthSensor.md)). [Hall Filament Width Sensor](Hall_Filament_Width_Sensor.md)).
``` ```
[hall_filament_width_sensor] [hall_filament_width_sensor]
@ -3870,7 +3870,7 @@ vssa_pin:
### [replicape] ### [replicape]
Replicape support - see the [beaglebone guide](beaglebone.md) and the Replicape support - see the [beaglebone guide](Beaglebone.md) and the
[generic-replicape.cfg](../config/generic-replicape.cfg) file for an [generic-replicape.cfg](../config/generic-replicape.cfg) file for an
example. example.

2
docs/FAQ.md
View File

@ -136,7 +136,7 @@ feature when printing (see
[config reference](Config_Reference.md#virtual_sdcard) for details). [config reference](Config_Reference.md#virtual_sdcard) for details).
For running on the Beaglebone, see the For running on the Beaglebone, see the
[Beaglebone specific installation instructions](beaglebone.md). [Beaglebone specific installation instructions](Beaglebone.md).
Klipper has been run on other machines. The Klipper host software only Klipper has been run on other machines. The Klipper host software only
requires Python running on a Linux (or similar) computer. However, if requires Python running on a Linux (or similar) computer. However, if

4
docs/G-Codes.md
View File

@ -663,7 +663,7 @@ retraction required.
The following commands are available when the The following commands are available when the
[skew_correction config section](Config_Reference.md#skew_correction) [skew_correction config section](Config_Reference.md#skew_correction)
is enabled (also see the [skew correction guide](skew_correction.md)): is enabled (also see the [Skew Correction](Skew_Correction.md) guide):
- `SET_SKEW [XY=<ac_length,bd_length,ad_length>] [XZ=<ac,bd,ad>] - `SET_SKEW [XY=<ac_length,bd_length,ad_length>] [XZ=<ac,bd,ad>]
[YZ=<ac,bd,ad>] [CLEAR=<0|1>]`: Configures the [skew_correction] [YZ=<ac,bd,ad>] [CLEAR=<0|1>]`: Configures the [skew_correction]
module with measurements (in mm) taken from a calibration print. module with measurements (in mm) taken from a calibration print.
@ -678,7 +678,7 @@ is enabled (also see the [skew correction guide](skew_correction.md)):
degrees) based on a measured print. This can be useful for degrees) based on a measured print. This can be useful for
determining the printer's current skew after correction has been determining the printer's current skew after correction has been
applied. It may also be useful before correction is applied to applied. It may also be useful before correction is applied to
determine if skew correction is necessary. See skew_correction.md determine if skew correction is necessary. See [Skew Correction](Skew_Correction.md)
for details on skew calibration objects and measurements. for details on skew calibration objects and measurements.
- `SKEW_PROFILE [LOAD=<name>] [SAVE=<name>] [REMOVE=<name>]`: Profile - `SKEW_PROFILE [LOAD=<name>] [SAVE=<name>] [REMOVE=<name>]`: Profile
management for skew_correction. LOAD will restore skew state from management for skew_correction. LOAD will restore skew state from

0
docs/HallFilamentWidthSensor.md → docs/Hall_Filament_Width_Sensor.md
View File

2
docs/Installation.md
View File

@ -9,7 +9,7 @@ for other machines).
Klipper currently supports a number of Atmel ATmega based Klipper currently supports a number of Atmel ATmega based
micro-controllers, micro-controllers,
[ARM based micro-controllers](Features.md#step-benchmarks), and [ARM based micro-controllers](Features.md#step-benchmarks), and
[Beaglebone PRU](beaglebone.md) based printers. [Beaglebone PRU](Beaglebone.md) based printers.
## Prepping an OS image ## Prepping an OS image

6
docs/Overview.md
View File

@ -50,7 +50,7 @@ communication with the Klipper developers.
with Klipper. with Klipper.
- [Multi-MCU Homing](Multi_MCU_Homing.md): Homing and probing using multiple micro-controllers. - [Multi-MCU Homing](Multi_MCU_Homing.md): Homing and probing using multiple micro-controllers.
- [Slicers](Slicers.md): Configure "slicer" software for Klipper. - [Slicers](Slicers.md): Configure "slicer" software for Klipper.
- [Skew correction](skew_correction.md): Adjustments for axes not - [Skew correction](Skew_Correction.md): Adjustments for axes not
perfectly square. perfectly square.
- [PWM tools](Using_PWM_Tools.md): Guide on how to use PWM controlled - [PWM tools](Using_PWM_Tools.md): Guide on how to use PWM controlled
tools such as lasers or spindles. tools such as lasers or spindles.
@ -85,10 +85,10 @@ communication with the Klipper developers.
copying a binary to an sdcard in the micro-controller. copying a binary to an sdcard in the micro-controller.
- [Raspberry Pi as Micro-controller](RPi_microcontroller.md): Details - [Raspberry Pi as Micro-controller](RPi_microcontroller.md): Details
for controlling devices wired to the GPIO pins of a Raspberry Pi. for controlling devices wired to the GPIO pins of a Raspberry Pi.
- [Beaglebone](beaglebone.md): Details for running Klipper on the - [Beaglebone](Beaglebone.md): Details for running Klipper on the
Beaglebone PRU. Beaglebone PRU.
- [Bootloaders](Bootloaders.md): Developer information on - [Bootloaders](Bootloaders.md): Developer information on
micro-controller flashing. micro-controller flashing.
- [CAN bus](CANBUS.md): Information on using CAN bus with Klipper. - [CAN bus](CANBUS.md): Information on using CAN bus with Klipper.
- [TSL1401CL filament width sensor](TSL1401CL_Filament_Width_Sensor.md) - [TSL1401CL filament width sensor](TSL1401CL_Filament_Width_Sensor.md)
- [Hall filament width sensor](HallFilamentWidthSensor.md) - [Hall filament width sensor](Hall_Filament_Width_Sensor.md)

0
docs/skew_correction.md → docs/Skew_Correction.md
View File

6
docs/_klipper3d/mkdocs.yml
View File

@ -101,7 +101,7 @@ nav:
- TMC_Drivers.md - TMC_Drivers.md
- Multi_MCU_Homing.md - Multi_MCU_Homing.md
- Slicers.md - Slicers.md
- skew_correction.md - Skew_Correction.md
- Using_PWM_Tools.md - Using_PWM_Tools.md
- Developer Documentation: - Developer Documentation:
- Code_Overview.md - Code_Overview.md
@ -118,8 +118,8 @@ nav:
- Example_Configs.md - Example_Configs.md
- SDCard_Updates.md - SDCard_Updates.md
- RPi_microcontroller.md - RPi_microcontroller.md
- beaglebone.md - Beaglebone.md
- Bootloaders.md - Bootloaders.md
- CANBUS.md - CANBUS.md
- TSL1401CL_Filament_Width_Sensor.md - TSL1401CL_Filament_Width_Sensor.md
- HallFilamentWidthSensor.md - Hall_Filament_Width_Sensor.md