GITBOOK-151: change request with no subject merged in GitBook

SUMMARY.md

@@ -64,17 +64,16 @@
   * [Environment](overview/development/environment.md)
   * [Localization](overview/development/localization.md)
 
-***
+## FAQ
 
-* [FAQ](faq/README.md)
-  * [Mainsail](faq/mainsail.md)
-  * [Klipper warnings](faq/klipper-warnings/README.md)
-    * [Deprecated Values](faq/klipper-warnings/deprecated-values.md)
-    * [Deprecated Options](faq/klipper-warnings/deprecated-options.md)
-  * [Moonraker warnings](faq/moonraker-warnings/README.md)
-    * [PolicyKit Permissions](faq/moonraker-warnings/policykit-permissions.md)
-  * [Klipper errors](faq/klipper-errors/README.md)
-    * [Command format mismatch](faq/klipper-errors/command-format-mismatch.md)
+* [Mainsail](faq/mainsail.md)
+* [Klipper warnings](faq/klipper\_warnings/README.md)
+  * [Deprecated Values](faq/klipper\_warnings/deprecated\_values.md)
+  * [Deprecated Options](faq/klipper\_warnings/deprecated\_options.md)
+* [Moonraker warnings](faq/moonraker\_warnings/README.md)
+  * [PolicyKit Permissions](faq/moonraker\_warnings/policykit-permissions.md)
+* [Klipper errors](faq/klipper\_errors/README.md)
+  * [Command format mismatch](faq/klipper\_errors/command-format-mismatch.md)
 
 ## About
 

faq/klipper-warnings/deprecated-options.md → faq/klipper_warnings/deprecated_options.md

@@ -1,12 +1,18 @@
 # Deprecated Options
 
-#### **default\_parameter**
+### Removal of `relative_reference_index` <a href="#relative_reference_index" id="relative_reference_index"></a>
 
-## Removal of `default_parameter_` for G-Code macros.
+The `relative_reference_index` option has been deprecated and superceded by the `zero_reference_position` option. Refer to the [Bed Mesh Documentation](https://www.klipper3d.org/Bed\_Mesh.html#the-deprecated-relative\_reference\_index) for details on how to update the configuration. With this deprecation the `RELATIVE_REFERENCE_INDEX` is no longer available as a parameter for the `BED_MESH_CALIBRATE` G-Code command.
+
+{% hint style="info" %}
+[Source](https://www.klipper3d.org/Config\_Changes.html) Klipper Configuration Changes
+{% endhint %}
+
+### Removal of `default_parameter_` for G-Code macros. <a href="#default_parameter" id="default_parameter"></a>
 
 In the past, default parameters for G-Code macros were defined like so:
 
-```
+```yaml
 [gcode_macro PRINT_START]
 default_parameter_EXTRUDER: 230
 gcode:
@@ -15,7 +21,7 @@ gcode:
 
 This would define a macro called `PRINT_START` that can be called with an `EXTRUDER` parameter like so: `PRINT_START EXTRUDER=200`. If no value is passed for `EXTRUDER` the default value of 230 is used. This style of default parameters has been deprecated. Instead, define your macro like so:
 
-```
+```yaml
 [gcode_macro PRINT_START]
 gcode:
   {% raw %}
@@ -34,9 +40,7 @@ Take note of the following important aspects:
 The above description was provided by our community member [FHeilmann](https://github.com/FHeilmann) and we have his permission to publish it here. Thanks a lot! [Source](https://gist.github.com/FHeilmann/a8097b3e908e85de7255bbe6246ddfd5)
 {% endhint %}
 
-#### **step\_distance**
-
-## Removal of `step_distance`
+### Removal of `step_distance` <a href="#step_distance" id="step_distance"></a>
 
 `step_distance` describes the distance covered by a certain axis with 1 stepper (micro-)step. The downside of this parameter (and one of the reasons for its removal, is that if one were to change the microstepping of a stepper, the step\_distance changes as well. Klipper therefore removed the `step_distance` parameter in favor of `rotation_distance` and `full_steps_per_rotation`. These two parameters are unaffected by microstepping, and can be easily determined by inspecting the used hardware.
 
@@ -56,9 +60,7 @@ Perform the following steps to convert your config:
 The above description was provided by our community member [FHeilmann](https://github.com/FHeilmann) and we have his permission to publish it here. Thanks a lot! [Source](https://gist.github.com/FHeilmann/a8097b3e908e85de7255bbe6246ddfd5)
 {% endhint %}
 
-#### **pin\_map**
-
-## Removal of `pin_map`
+### Removal of `pin_map` <a href="#pin_map" id="pin_map"></a>
 
 For Voron printers, this is only relevant if you’re running an Arduino based controller board and use pins named similar to `ar19` etc. These pin declarations are no longer valid and need to be replaced with their hardware pin identifiers. To find the appropriate hardware pin identifier perform a google image search for your board plus `pinout`. E.g.:
 
@@ -72,7 +74,7 @@ There, find the pin you’re trying to replace. The old pin maps use the digital
 
 Alternatively, you can copy an appropriate `[board_pins]` block from [this location](https://github.com/Klipper3d/klipper/blob/master/config/sample-aliases.cfg) to your config. If you’re using multiple Arduinos, make sure to add the appropriate `mcu` to each block like so:
 
-```
+```yaml
 [board_pins arduino-mega]
 mcu: mcu
 ```
@@ -81,9 +83,7 @@ mcu: mcu
 The above description was provided by our community member [FHeilmann](https://github.com/FHeilmann) and we have his permission to publish it here. Thanks a lot! [Source](https://gist.github.com/FHeilmann/a8097b3e908e85de7255bbe6246ddfd5)
 {% endhint %}
 
-#### **pid\_integral\_max**
-
-## Removal of `pid_integral_max`
+### Removal of `pid_integral_max` <a href="#pid_integral_max" id="pid_integral_max"></a>
 
 Remove any instances of `pid_integral_max` from your config.
 

faq/klipper-warnings/deprecated-values.md → faq/klipper_warnings/deprecated_values.md

@@ -1,8 +1,6 @@
 # Deprecated Values
 
-#### **NTC 100K beta 3950**
-
-## Removal of `NTC 100K beta 3950` sensor type.
+### Removal of `NTC 100K beta 3950` sensor type. <a href="#ntc-100k-beta-3950" id="ntc-100k-beta-3950"></a>
 
 The “NTC 100K beta 3950” temperature sensor is _deprecated_ and will be removed in the near future.
 
@@ -14,9 +12,7 @@ Most users will find the “Generic 3950” temperature sensor more accurate. An
 [Source](https://www.klipper3d.org/Config\_Changes.html) Klipper Configuration Changes
 {% endhint %}
 
-#### **rpi\_temperature**
-
-## Removal of `rpi_temperature` sensor alias.
+### Removal of `rpi_temperature` sensor alias. <a href="#rpi_temperature" id="rpi_temperature"></a>
 
 Replace `sensor_type: rpi_temperature` by `sensor_type: temperature_host` everywhere in your config.
 

overview/settings/webcams.md

@@ -6,10 +6,10 @@
 
 To be able to add a stream to Mainsail, it must be available as a so-called “MJPEG stream”.
 
-So either you have a network camera that offers such a stream by itself, or you use a conventional webcam (USB camera, Raspberry Pi Camera, …) that is connected to your system. For a non-network cameras, you need to install and configure a streamer software on your system, such as [Crowsnest](http://localhost:5000/o/O2j4rN2JOaGEeS1KBjXz/s/qXE1OQLsr0XFNbT54RTY/). 
+So either you have a network camera that offers such a stream by itself, or you use a conventional webcam (USB camera, Raspberry Pi Camera, …) that is connected to your system. For a non-network cameras, you need to install and configure a streamer software on your system, such as [Crowsnest](http://127.0.0.1:5000/o/O2j4rN2JOaGEeS1KBjXz/s/qXE1OQLsr0XFNbT54RTY/). 
 
 {% hint style="info" %}
-[MainsailOS ](http://localhost:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/)comes preinstalled with [Crowsnest](http://localhost:5000/o/O2j4rN2JOaGEeS1KBjXz/s/qXE1OQLsr0XFNbT54RTY/) as streamer. If you wish to install Crowsnest on your system, or need assistance in configuring Crowsnest, please refer to its documentation.
+[MainsailOS ](http://127.0.0.1:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/)comes preinstalled with [Crowsnest](http://127.0.0.1:5000/o/O2j4rN2JOaGEeS1KBjXz/s/qXE1OQLsr0XFNbT54RTY/) as streamer. If you wish to install Crowsnest on your system, or need assistance in configuring Crowsnest, please refer to its documentation.
 {% endhint %}
 
 Once such a stream is available, you only have to configure it in the Mainsail settings. 
@@ -45,7 +45,7 @@ At first, you have to give the camera a name, and you can assign an icon to it.
 
 You also need to specify stream and snapshot URL. For network cameras, please consult the manufacturer's manual or search the Internet.
 
-**Note:** In [MainsailOS](http://localhost:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/), by default, four webcam ports are mapped to URLs. Notice that the first URL doesn't contain a number. Check which port you have configured in your streamer and add the URLs.
+**Note:** In [MainsailOS](http://127.0.0.1:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/), by default, four webcam ports are mapped to URLs. Notice that the first URL doesn't contain a number. Check which port you have configured in your streamer and add the URLs.
 
 <table><thead><tr><th width="150">Port</th><th>Stream URL</th><th>Snapshot URL</th></tr></thead><tbody><tr><td>8080</td><td>/webcam/?action=stream</td><td>/webcam/?action=snapshot</td></tr><tr><td>8081</td><td>/webcam2/?action=stream</td><td>/webcam2/?action=snapshot</td></tr><tr><td>8082</td><td>/webcam3/?action=stream</td><td>/webcam3/?action=snapshot</td></tr><tr><td>8083</td><td>/webcam4/?action=stream</td><td>/webcam4/?action=snapshot</td></tr></tbody></table>
 

setup/configuration.md

@@ -81,6 +81,7 @@ gcode:
   {% endif %}
 {% endraw %}
 
+
   RESUME_BASE {get_params}
 ```
 
@@ -98,6 +99,7 @@ gcode:
   {% endif %}
 {% endraw %}
 
+
   TURN_OFF_HEATERS
   CANCEL_PRINT_BASE
 ```

setup/getting-started.md

@@ -12,8 +12,8 @@ _<mark style="color:red;">recommended for Raspberry Pi users</mark>_
 
 MainsailOS is a prebuilt image for single board computers that already includes Mainsail, Moonraker and Klipper. The least amount of setup.
 
-{% content-ref url="http://localhost:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/" %}
-[MainsailOS](http://localhost:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/)
+{% content-ref url="http://127.0.0.1:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/" %}
+[MainsailOS](http://127.0.0.1:5000/o/O2j4rN2JOaGEeS1KBjXz/s/HZGYoL7ogomNyBLNEpEJ/)
 {% endcontent-ref %}
 
 ### KIAUH - _Klipper Installation And Update Helper_