From a1af78cb83eb91c20126d02012ad8a20405470b4 Mon Sep 17 00:00:00 2001 From: Yifei Ding Date: Sat, 20 Nov 2021 23:23:56 -0800 Subject: [PATCH] docs: Rename Documents Signed-off-by: Yifei Ding --- docs/{beaglebone.md => Beaglebone.md} | 0 docs/Config_Changes.md | 2 +- docs/Config_Reference.md | 8 ++++---- docs/FAQ.md | 2 +- docs/G-Codes.md | 4 ++-- ...lamentWidthSensor.md => Hall_Filament_Width_Sensor.md} | 0 docs/Installation.md | 2 +- docs/Overview.md | 6 +++--- docs/{skew_correction.md => Skew_Correction.md} | 0 docs/_klipper3d/mkdocs.yml | 6 +++--- 10 files changed, 15 insertions(+), 15 deletions(-) rename docs/{beaglebone.md => Beaglebone.md} (100%) rename docs/{HallFilamentWidthSensor.md => Hall_Filament_Width_Sensor.md} (100%) rename docs/{skew_correction.md => Skew_Correction.md} (100%) diff --git a/docs/beaglebone.md b/docs/Beaglebone.md similarity index 100% rename from docs/beaglebone.md rename to docs/Beaglebone.md diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md index 900aad82..e91ff465 100644 --- a/docs/Config_Changes.md +++ b/docs/Config_Changes.md @@ -308,7 +308,7 @@ that command. 20190628: All configuration options have been removed from the [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. 20190607: The "variable_X" parameters of gcode_macro (along with the diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index ca601db3..e151dbcf 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -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 calibration model along a plane and measuring three lengths. Due to the nature of skew correction these lengths are set via gcode. See -[skew correction](skew_correction.md) and -[command reference](G-Codes.md#skew-correction) for details. +[Skew Correction](Skew_Correction.md) and +[Command Reference](G-Codes.md#skew-correction) for details. ``` [skew_correction] @@ -3727,7 +3727,7 @@ TSLl401CL Based Filament Width Sensor. See the ### [hall_filament_width_sensor] Hall filament width sensor (see -[Hall Filament Width Sensor](HallFilamentWidthSensor.md)). +[Hall Filament Width Sensor](Hall_Filament_Width_Sensor.md)). ``` [hall_filament_width_sensor] @@ -3870,7 +3870,7 @@ vssa_pin: ### [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 example. diff --git a/docs/FAQ.md b/docs/FAQ.md index 7724d2c9..c671d05d 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -136,7 +136,7 @@ feature when printing (see [config reference](Config_Reference.md#virtual_sdcard) for details). 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 requires Python running on a Linux (or similar) computer. However, if diff --git a/docs/G-Codes.md b/docs/G-Codes.md index 9c62acff..01e16570 100644 --- a/docs/G-Codes.md +++ b/docs/G-Codes.md @@ -663,7 +663,7 @@ retraction required. The following commands are available when the [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=] [XZ=] [YZ=] [CLEAR=<0|1>]`: Configures the [skew_correction] 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 determining the printer's current skew after correction has been 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. - `SKEW_PROFILE [LOAD=] [SAVE=] [REMOVE=]`: Profile management for skew_correction. LOAD will restore skew state from diff --git a/docs/HallFilamentWidthSensor.md b/docs/Hall_Filament_Width_Sensor.md similarity index 100% rename from docs/HallFilamentWidthSensor.md rename to docs/Hall_Filament_Width_Sensor.md diff --git a/docs/Installation.md b/docs/Installation.md index b4e77e2f..a8f5373d 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -9,7 +9,7 @@ for other machines). Klipper currently supports a number of Atmel ATmega based micro-controllers, [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 diff --git a/docs/Overview.md b/docs/Overview.md index a758a991..1bd85eb1 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -50,7 +50,7 @@ communication with the Klipper developers. with Klipper. - [Multi-MCU Homing](Multi_MCU_Homing.md): Homing and probing using multiple micro-controllers. - [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. - [PWM tools](Using_PWM_Tools.md): Guide on how to use PWM controlled 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. - [Raspberry Pi as Micro-controller](RPi_microcontroller.md): Details 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. - [Bootloaders](Bootloaders.md): Developer information on micro-controller flashing. - [CAN bus](CANBUS.md): Information on using CAN bus with Klipper. - [TSL1401CL filament width sensor](TSL1401CL_Filament_Width_Sensor.md) -- [Hall filament width sensor](HallFilamentWidthSensor.md) +- [Hall filament width sensor](Hall_Filament_Width_Sensor.md) diff --git a/docs/skew_correction.md b/docs/Skew_Correction.md similarity index 100% rename from docs/skew_correction.md rename to docs/Skew_Correction.md diff --git a/docs/_klipper3d/mkdocs.yml b/docs/_klipper3d/mkdocs.yml index f173f6b5..b2ebfcd1 100644 --- a/docs/_klipper3d/mkdocs.yml +++ b/docs/_klipper3d/mkdocs.yml @@ -101,7 +101,7 @@ nav: - TMC_Drivers.md - Multi_MCU_Homing.md - Slicers.md - - skew_correction.md + - Skew_Correction.md - Using_PWM_Tools.md - Developer Documentation: - Code_Overview.md @@ -118,8 +118,8 @@ nav: - Example_Configs.md - SDCard_Updates.md - RPi_microcontroller.md - - beaglebone.md + - Beaglebone.md - Bootloaders.md - CANBUS.md - TSL1401CL_Filament_Width_Sensor.md - - HallFilamentWidthSensor.md + - Hall_Filament_Width_Sensor.md