docs: Move config reference information to new Config_Reference.md

Move all the config reference information from files in the config/
directory to a new Config_Reference.md document.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>

docs/Benchmarks.md

@@ -427,5 +427,5 @@ It is possible to run timing tests on the host software using the
 large and complex G-Code file and timing how long it takes for the
 host software to process it. For example:
 ```
-time ~/klippy-env/bin/python ./klippy/klippy.py config/example.cfg -i something_complex.gcode -o /dev/null -d out/klipper.dict
+time ~/klippy-env/bin/python ./klippy/klippy.py config/example-cartesian.cfg -i something_complex.gcode -o /dev/null -d out/klipper.dict
 ```

docs/Endstop_Phase.md

@@ -105,8 +105,8 @@ Additional notes
   enable this feature be sure the G-Code slicer is configured with a
   layer height that is a multiple of a "full step", manually enable
   the endstop_align_zero option in the endstop_phase config section
-  (see config/example-extras.cfg for further details), and then
-  re-level the bed screws.
+  (see [config reference](Config_Reference.md#endstop_phase) for
+  further details), and then re-level the bed screws.
 
 * It is possible to use this system with traditional (non-Trinamic)
   stepper motor drivers. However, doing this requires making sure that
@@ -122,4 +122,5 @@ Additional notes
   power reset, which would arrange for both the micro-controller and
   stepper motor drivers to be reset together. If using this mechanism,
   one would then need to manually configure the "endstop_phase" config
-  sections (see config/example-extras.cfg for the details).
+  sections (see [config reference](Config_Reference.md#endstop_phase)
+  for the details).

docs/FAQ.md

@@ -121,8 +121,9 @@ If you want to change the baud rate anyway, then the new rate will
 need to be configured in the micro-controller (during **make
 menuconfig**) and that updated code will need to be compiled and
 flashed to the micro-controller. The Klipper printer.cfg file will
-also need to be updated to match that baud rate (see the example.cfg
-file for details).  For example:
+also need to be updated to match that baud rate (see the
+[config reference](Config_Reference.md#mcu) for details).  For
+example:
 ```
 [mcu]
 baud: 250000
@@ -149,8 +150,7 @@ when printing directly from OctoPrint. (The printer may move faster
 than OctoPrint can send movement commands.) If you wish to run on one
 one of these slower boards anyway, consider using the "virtual_sdcard"
 feature when printing (see
-[config/example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-for details).
+[config reference](Config_Reference.md#virtual_sdcard) for details).
 
 For running on the Beaglebone, see the
 [Beaglebone specific installation instructions](beaglebone.md).
@@ -237,8 +237,7 @@ process itself (or fundamentally does not have a homing process) then
 consider using a safe_z_home or homing_override section in the config
 file. If you need to move a stepper for diagnostic or debugging
 purposes then consider adding a force_move section to the config
-file. See
-[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
+file. See [config reference](Config_Reference.md#customized_homing)
 for further details on these options.
 
 ### Why is the Z position_endstop set to 0.5 in the default configs?
@@ -341,16 +340,14 @@ See the "config_digital_out" command in the
 In addition, the micro-controller software is configured with a
 minimum and maximum temperature range for each heater at startup (see
 the min_temp and max_temp parameters in the
-[example.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example.cfg)
-file for details). If the micro-controller detects that the
-temperature is outside of that range then it will also enter a
-"shutdown" state.
+[config reference](Config_Reference.md#extruder) for details). If the
+micro-controller detects that the temperature is outside of that range
+then it will also enter a "shutdown" state.
 
 Separately, the host software also implements code to check that
 heaters and temperature sensors are functioning correctly. See the
-"verify_heater" section of the
-[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-for further details.
+[config reference](Config_Reference.md#verify_heater) for further
+details.
 
 ### How do I convert a Marlin pin number to a Klipper pin name?
 

docs/G-Codes.md

@@ -44,9 +44,9 @@ possible G-Code command. Instead, Klipper prefers human readable
 
 If one requires a less common G-Code command then it may be possible
 to implement it with a custom Klipper gcode_macro (see
-[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-for details). For example, one might use this to implement: `G12`,
-`G29`, `G30`, `G31`, `M42`, `M80`, `M81`, `T1`, etc.
+[config reference](Config_Reference.md#gcode_macro) for details). For
+example, one might use this to implement: `G12`, `G29`, `G30`, `G31`,
+`M42`, `M80`, `M81`, `T1`, etc.
 
 ## G-Code SD card commands
 
@@ -320,9 +320,7 @@ enabled:
   [SAMPLES_RESULT=median|average]`: Move the nozzle downwards until
   the probe triggers. If any of the optional parameters are provided
   they override their equivalent setting in the probe config section
-  (see
-  [example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-  for details).
+  (see [config reference](Config_Reference.md#probe) for details).
 - `QUERY_PROBE`: Report the current status of the probe ("triggered"
   or "open").
 - `PROBE_ACCURACY [PROBE_SPEED=<mm/s>] [SAMPLES=<count>]
@@ -622,15 +620,17 @@ been enabled:
 The following command is enabled if an [input_shaper] config section has
 been enabled:
   - `SET_INPUT_SHAPER [SHAPER_FREQ_X=<shaper_freq_x>]
-    [SHAPER_FREQ_Y=<shaper_freq_y>] [DAMPING_RATIO_X=<damping_ratio_x>]
+    [SHAPER_FREQ_Y=<shaper_freq_y>]
+    [DAMPING_RATIO_X=<damping_ratio_x>]
     [DAMPING_RATIO_Y=<damping_ratio_y>] [SHAPER_TYPE=<shaper>]
-    [SHAPER_TYPE_X=<shaper_type_x>] [SHAPER_TYPE_Y=<shaper_type_y>]`: Modify
-    input shaper parameters. Note that SHAPER_TYPE parameter resets input shaper
-    for both X and Y axes even if different shaper types have been configured
-    in [input_shaper] section. SHAPER_TYPE cannot be used together with either
-    of SHAPER_TYPE_X and SHAPER_TYPE_Y parameters. See
-    [example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-    for more details on each of these parameters.
+    [SHAPER_TYPE_X=<shaper_type_x>] [SHAPER_TYPE_Y=<shaper_type_y>]`:
+    Modify input shaper parameters. Note that SHAPER_TYPE parameter
+    resets input shaper for both X and Y axes even if different shaper
+    types have been configured in [input_shaper] section. SHAPER_TYPE
+    cannot be used together with either of SHAPER_TYPE_X and
+    SHAPER_TYPE_Y parameters. See
+    [config reference](Config_Reference.md#input_shaper) for more
+    details on each of these parameters.
 
 ## Temperature Fan Commands
 

docs/Installation.md

@@ -127,10 +127,8 @@ Configuring Klipper
 The Klipper configuration is stored in a text file on the Raspberry
 Pi. Take a look at the example config files in the
 [config directory](https://github.com/KevinOConnor/klipper/tree/master/config/). The
-[example.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example.cfg)
-file contains documentation on command parameters and it can also be
-used as an initial config file template. However, for most printers,
-one of the other config files may be a more concise starting point.
+[config reference](Config_Reference.md) contains documentation on
+config parameters.
 
 Arguably the easiest way to update the Klipper configuration file is
 to use a desktop editor that supports editing files over the "scp"
@@ -144,7 +142,7 @@ Alternatively, one can also copy and edit the file directly on the
 Raspberry Pi via ssh - for example:
 
 ```
-cp ~/klipper/config/example.cfg ~/printer.cfg
+cp ~/klipper/config/example-cartesian.cfg ~/printer.cfg
 nano ~/printer.cfg
 ```
 

docs/Overview.md

@@ -15,8 +15,8 @@ communication with the Klipper developers.
 # Configuration and Tuning Guides
 
 - [Installation](Installation.md): Guide to installing Klipper.
-  - [config/example.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example.cfg)
-    a reference for the config file.
+- [Config Reference](Config_Reference.md): Description of config
+  parameters.
 - [Config checks](Config_checks.md): Verify basic pin settings in the
   config file.
 - [Bed level](Bed_Level.md): Information on "bed leveling" in Klipper.

docs/Probe_Calibrate.md

@@ -130,9 +130,8 @@ different parameters to see their impact - see the
 generally obtains repeatable results but has an occasional outlier,
 then it may be possible to account for that by using multiple samples
 on each probe - read the description of the probe `samples` config
-parameters in the
-[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-file for more details.
+parameters in the [config reference](Config_Reference.md#probe) for
+more details.
 
 If new probe speed, samples count, or other settings are needed, then
 update the printer.cfg file and issue a `RESTART` command. If so, it

docs/Sensorless_Homing.md

@@ -61,7 +61,7 @@ The name of the virtual end stop pin is derived from the name of the TMC2130 sec
 
 The TMC2130 and TMC5160 have both a `diag0_pin` and `diag1_pin` in most known hardware the `diag1_pin` is appropriate. In order for klipper to correctly configure the driver for sensorless homing, the correct configuration property name `diag0_pin` or `diag1_pin` must be used. Which is used is determined by which driver pin is connected to the MCU pin.
 
-ATTENTION: This guide only mentions the mandatory parameters and the ones needed to set up sensorless homing. There are many other options to configure on a TMC2130, make sure to take a look at `config/example-extras.cfg` for all the available options.
+ATTENTION: This guide only mentions the mandatory parameters and the ones needed to set up sensorless homing. There are many other options to configure on a TMC2130, make sure to take a look at [config reference](Config_Reference.md#tmc2130) for all the available options.
 
 ## Testing of SPI/UART communication
 Now that the stepper driver is configured, let's make sure that Klipper can communicate with the TMC2130 by sending the following extended G-Code command to the printer:

docs/Slicers.md

@@ -22,9 +22,8 @@ See
 [sample-macros.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/sample-macros.cfg)
 for example START_PRINT and END_PRINT macros.
 
-See the
-[example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-file for details on defining a gcode_macro.
+See the [config reference](Config_Reference.md#gcode_macro) for
+details on defining a gcode_macro.
 
 # Large retraction settings may require tuning Klipper
 

docs/beaglebone.md

@@ -100,6 +100,5 @@ Unfortunately, the Beaglebone processor can sometimes struggle to run
 OctoPrint well. Print stalls have been known to occur on complex
 prints (the printer may move faster than OctoPrint can send movement
 commands). If this occurs, consider using the "virtual_sdcard" feature
-(see
-[config/example-extras.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example-extras.cfg)
-for details) to print directly from Klipper.
+(see [config reference](Config_Reference.md#virtual_sdcard) for
+details) to print directly from Klipper.