Docs: fix build errors and broken links

Rat-OS · Dec 19, 2024 · 74ea717 · 74ea717
1 parent 2f408a1
commit 74ea717
Show file tree

Hide file tree

Showing 25 changed files with 229 additions and 206 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,4 +22,4 @@ build.log
 .*.swp
 
 # Ignore built docs
-./docs/
+docs/**
diff --git a/site/blog/2021-11-14-ratos-v1-0-released.mdx b/site/blog/2021-11-14-ratos-v1-0-released.mdx
@@ -12,6 +12,8 @@ tags: [RatOS, Releases]
 RatOS V1.0 is finally released, it's been a long road to get here, thank you everyone who has been testing and supporting me get this release completed.
 There's a lot of new exciting features that i'm dying to share with you all.
 
+{/* truncate */}
+
 ### Mainsail is here!
 
 RatOS now ships with Mainsail as the default UI. The Mainsail team has been teasing a lot of awesome features lately and now RatOS users get them too.
@@ -24,7 +26,7 @@ It hasn't been very clear to beginners, what they need to do to get things worki
 This is now a thing of the past!
 
 Unfortunately there's an exception for the Octopus Pro 429, since there's currently no way to flash that board automatically.
-Read more about that in the [Octopus Pro 429 Board Documentation](/docs/boards/btt/octopus-pro-429#firmware-installation)
+Read more about that in the [Octopus Pro 429 Board Documentation](/docs/1.2.x/boards/btt/octopus-pro-429#firmware-installation)
 
 ### RPi as additional MCU.
 

diff --git a/site/blog/2022-01-08-ratos-v1-1-released.mdx b/site/blog/2022-01-08-ratos-v1-1-released.mdx
@@ -12,11 +12,13 @@ tags: [RatOS, Releases]
 As some of you may have noticed, RatOS v1.1 has been released this week, bringing new templates, new modular driver and stepper definitions and
 support for new extruders and hotends. This release also contains an updated V-Minion template that will run out of the box with the just released [V-Minion full kits](https://www.ratrig.com/v-minion.html) that will start shipping soon.
 
+{/* truncate */}
+
 ### Changes to stepper motors and driver settings.
 
 This release mainly revolves around the new stepper/stepper driver setting recommendations from Klipper. `Hold_current` has been removed, stealthchop is now entirely disabled by default, interpolation has been disabled and microsteps have been increased to 64 to counteract the additional noise. This increases precision and you may see an increase in print quality.
 This change comes with the side effect of increased "R2D2 noise", tuned driver settings for the most used steppers have been included to combat this, but they will never be as silent in standstill as with stealthchop_threshold: 1. If you want a quieter printer refer to the "stealth mode" includes in the new printer templates, this will turn on stealthchop and limit print velocity at the cost of significantly reduced torque and precision.
-A nice consequence of this change is that it made it easier to make drivers and steppers more modular, it's now much easier to run high voltage steppers on some stepper slots, read more in the [Advanced Stepper Configuration](/docs/configuration/advanced-stepper-configuration) guide.
+A nice consequence of this change is that it made it easier to make drivers and steppers more modular, it's now much easier to run high voltage steppers on some stepper slots, read more in the [Advanced Stepper Configuration](/docs/1.2.x/configuration/advanced-stepper-configuration) guide.
 
 ### Updating from RatOS v1.0
 

diff --git a/site/blog/2022-10-17-moonraker-config-changes.mdx b/site/blog/2022-10-17-moonraker-config-changes.mdx
@@ -9,6 +9,8 @@ tags: [RatOS, Moonraker]
 
 As you might know, a couple of weeks ago, I issued a warning about updating moonraker due to a major change that involved file restructuring, config changes and deprecations. I now believe i've ironed out all the kinks, and I can now say that the update is safe to do, as long as you update RatOS first, as usual.
 
+{/* truncate */}
+
 **There are a few things to note about this update:**
 
 Users who installed RatOS before 1.2.1 have an unmanaged moonraker config, this means that it's up to the user to manage it and RatOS can't correct it when things need updating. Fear not though, as most of this is automated by moonraker itself. When you update moonraker, make sure to keep an eye on the notifications in the topmenu, there's a chance you might have to follow the instructions in there to finish the config validation. If you're asked to enter a sudo password, the default is `raspberry`.

diff --git a/site/blog/2022-11-08-no-you-dont-want-to-use-can.mdx b/site/blog/2022-11-08-no-you-dont-want-to-use-can.mdx
@@ -9,6 +9,8 @@ tags: [RatOS, CAN, USB, Klipper, Rant]
 
 For some reason, the entire 3d printing community has convinced itself that it needs to use CAN bus connections for everything. I'm here to tell you why that's a waste of your time when running klipper.
 
+{/* truncate */}
+
 ## What is CAN bus?
 
 CAN bus is a multi-master protocol in which any device can initiate a message to any other on embedded systems where every device is known and there are no strangers. It can work over long distances and is less susceptible to noise than USB.

diff --git a/site/blog/2023-03-04-ratos-v2-0-0-released.mdx b/site/blog/2023-03-04-ratos-v2-0-0-released.mdx
@@ -13,6 +13,8 @@ This is a huge milestone and I'm very excited to finally release RatOS V2.0.0!
 
 There's been quite a few changes since the last release, so I'll quickly go over the most notable ones, feel free to check out the [changelog](https://os.ratrig.com/changelog#ratos-v20) for the complete picture!
 
+{/* truncate */}
+
 ### Toolboards
 
 You asked for it, and now it's finally here! Toolboards are now supported! There are currently 8 supported models to choose from, and more are on the way. The supported toolboards can be used with any of the control boards and any supported printer. As of the time of writing, RatOS currently supports the following toolboards:

diff --git a/site/blog/2023-05-23-breaking-crowsnest-changes.mdx b/site/blog/2023-05-23-breaking-crowsnest-changes.mdx
@@ -7,6 +7,8 @@ tags: [Crowsnest, Mainsail]
 
 Crowsnest just recently made huge changes to the way it works. This is great news, because it should be much faster and more reliable. Unfortunately, it also means that there are major breaking changes, and you'll need to do some manual steps to upgrade. When you update to V4 through the machine tab in mainsail, crowsnest will stop working until you execute the following steps.
 
+{/* truncate */}
+
 Make sure to read these instructions carefully before starting the process, so you don't miss anything. Just to be safe, download a copy of your crowsnest.conf.
 
 ## Upgrading

diff --git a/site/docs/boards/fysetc/spider-11.md b/site/docs/boards/fysetc/spider-11.md
@@ -40,7 +40,7 @@ Follow the steps in the RatOS Configurator at [http://RatOS.local/configure?step
 
 ## Setup
 
-If you're going through initial setup please continue in the [installation guide](installation.md#setup)
+If you're going through initial setup please continue in the [installation guide](/docs/installation#setting-up-your-printer)
 
 ## ADXL345 Connection
 

diff --git a/site/docs/boards/list.md b/site/docs/boards/list.md
@@ -13,28 +13,28 @@ RatOS currently supports the following control boards:
 
 ### Big Tree Tech
 
-- [BIGTREETECH SKRat v1.0](btt/skrat-10.mdx)
-- [BIGTREETECH SKR 2 429](btt/skr-2-429.md)
-- [BIGTREETECH SKR 2 407](btt/skr-2-429.md)
-- [BIGTREETECH SKR 3](btt/skr-3.mdx)
-- [BIGTREETECH SKR 3 H723](btt/skr-3.md)
-- [BIGTREETECH SKR 3 EZ](btt/skr-3-ez.mdx)
-- [BIGTREETECH SKR 3 EZ H723](btt/skr-3-ez.md)
-- [BIGTREETECH Octopus v1.1](btt/octopus-11.md)
-- [BIGTREETECH Octopus v1.1 F407](btt/octopus-11-407.md)
-- [BIGTREETECH Octopus Max EZ](btt/octopus-max-ez.mdx)
-- [BIGTREETECH Octopus Pro 446](btt/octopus-pro-446.md)
-- [BIGTREETECH Octopus Pro 429](btt/octopus-pro-429.md)
-- [BIGTREETECH Octopus Pro H723 v1.0](btt/octopus-pro-h723.md)
-- [BIGTREETECH Octopus Pro H723 v1.1](btt/octopus-pro-h723.md)
-- [BIGTREETECH Manta M4P v1.0](btt/manta-m4p-10.mdx)
-- [BIGTREETECH Manta M4P v2.2](btt/manta-m4p-22.mdx)
+- [BIGTREETECH SKRat v1.0](btt/skrat-10)
+- [BIGTREETECH SKR 2 429](btt/skr-2-429)
+- [BIGTREETECH SKR 2 407](btt/skr-2-429)
+- [BIGTREETECH SKR 3](btt/skr-3)
+- [BIGTREETECH SKR 3 H723](btt/skr-3)
+- BIGTREETECH SKR 3 EZbtt/skr-3-ez
+- BIGTREETECH SKR 3 EZ H723btt/skr-3-ez
+- [BIGTREETECH Octopus v1.1](btt/octopus-11)
+- [BIGTREETECH Octopus v1.1 F407](btt/octopus-11-407)
+- [BIGTREETECH Octopus Max EZ](btt/octopus-max-ez)
+- [BIGTREETECH Octopus Pro 446](btt/octopus-pro-446)
+- [BIGTREETECH Octopus Pro 429](btt/octopus-pro-429)
+- [BIGTREETECH Octopus Pro H723 v1.0](btt/octopus-pro-h723)
+- [BIGTREETECH Octopus Pro H723 v1.1](btt/octopus-pro-h723)
+- [BIGTREETECH Manta M4P v1.0](btt/manta-m4p-10)
+- [BIGTREETECH Manta M4P v2.2](btt/manta-m4p-22)
 - BIGTREETECH Manta M5P
-- [BIGTREETECH Manta M8P v1.0](btt/manta-m8p.mdx)
-- [BIGTREETECH Manta M8P v1.1](btt/manta-m8p-11.mdx)
-- [BIGTREETECH Manta E3EZ](btt/manta-e3ez.mdx)
-- [BIGTREETECH SKR Pro v1.2](btt/skr-pro-12.md)
-- [BIGTREETECH SKR Mini E3 V3.0](btt/skr-mini-e3-30.mdx)
+- [BIGTREETECH Manta M8P v1.0](btt/manta-m8p)
+- [BIGTREETECH Manta M8P v1.1](btt/manta-m8p-11)
+- [BIGTREETECH Manta E3EZ](btt/manta-e3ez)
+- [BIGTREETECH SKR Pro v1.2](btt/skr-pro-12)
+- [BIGTREETECH SKR Mini E3 V3.0](btt/skr-mini-e3-30)
 - BIGTREETECH Kraken
 
 ## LDO
@@ -43,10 +43,10 @@ RatOS currently supports the following control boards:
 
 ### Fysetc
 
-- [Fysetc Spider v1.1](fysetc/spider-11.md)
+- [Fysetc Spider v1.1](fysetc/spider-11)
 - Fysetc Spider v2.2
 
 ### Prusa
 
-- [Prusa Einsy](prusa/einsy.mdx)
+- [Prusa Einsy](prusa/einsy)
 - Prusa Buddy
diff --git a/site/docs/configuration/chamber_heater.md b/site/docs/configuration/chamber_heater.md
@@ -3,8 +3,8 @@
 RatOS includes built-in chamber heater control that supports three different scenarios:
 
 - [1. Bed Heater](#1-bed-heater)
-- [2. Internal Heater](#2-internal-heater)
-- [3. External Heater](#3-external-heater)
+- [2. Internal Heater](#2-internal-klipperratos-controlled-heater)
+- [3. External Heater](#3-external-stand-alone-controller-heater)
 
 ## Prerequisites
 

diff --git a/site/docs/configuration/filament_sensors.md b/site/docs/configuration/filament_sensors.md
@@ -12,14 +12,14 @@ Sensors can be temporarily deactivated in the Mainsail user interface.
 If a sensor shows "detected" when no filament is loaded and "empty" when filament is loaded, invert the `switch_pin` by adding or removing a `!` in front of the pin name. The sensor state will be displayed in the Mainsail user interface.
 :::
 
-### Supported Sensors
+## Supported Sensors
 
 - [Toolhead Filament Sensor](#toolhead-filament-sensor)
 - [Bowden Filament Sensor](#bowden-filament-sensor)
 - [Motion Filament Sensor](#motion-filament-sensor)
 - [Action Button](#action-button)
 
-### RatOS Configuration
+## RatOS Configuration
 
 - [Sensor features](#sensor-features)
 - [Filament grabbing](#filament-grabbing)
@@ -28,7 +28,7 @@ If a sensor shows "detected" when no filament is loaded and "empty" when filamen
 - [Retraction](#retraction)
 - [Advanced](#advanced)
 
-# Toolhead Filament Sensor
+## Toolhead Filament Sensor
 
 Toolhead filament sensors attach directly to the toolhead.
 
@@ -57,7 +57,7 @@ insert_gcode:
     _ON_TOOLHEAD_FILAMENT_SENSOR_INSERT TOOLHEAD=0
 ```
 
-# Bowden Filament Sensor
+## Bowden Filament Sensor
 
 Bowden filament sensors attach somewhere along the bowden tube.
 
@@ -83,7 +83,7 @@ insert_gcode:
     _ON_BOWDEN_FILAMENT_SENSOR_INSERT TOOLHEAD=0
 ```
 
-# Motion Filament Sensor
+## Motion Filament Sensor
 
 Motion sensors can detect filament clogs.
 
@@ -110,7 +110,7 @@ runout_gcode:
 insert_gcode:
 ```
 
-# Action Button
+## Action Button
 
 Some filament sensors, like the Orbiter filament sensor, come with an action button.
 
@@ -128,7 +128,7 @@ release_gcode:
 press_gcode:
 ```
 
-# Orbiter Smart Filament Sensor example configuration
+## Orbiter Smart Filament Sensor example configuration
 
 The new Orbiter Smart Filament Sensor with filament tangle detection.
 
@@ -153,7 +153,7 @@ release_gcode:
 press_gcode:
 ```
 
-# RatOS Configuration
+## RatOS Configuration
 
 ### Sensor features
 

diff --git a/site/docs/introduction.mdx b/site/docs/introduction.mdx
@@ -70,13 +70,29 @@ To run RatOS on your printer you need a supported control board and a Raspberry
 
 ## Currently Supported Printers
 
--   [Rat Rig V-Core 3](printers/v-core-3.md)
--   [Rat Rig V-Core Pro 1.3](printers/v-core-pro.md)
--   [Rat Rig V-Minion](printers/v-minion.md)
--   [Voron V0.1 (experimental)](printers/voron-v01.md)
--   [Voron V2.4 (experimental)](printers/voron-v24.md)
--   Prusa Mini (experimental)
--   Prusa MK3S (experimental)
+### Official Support
+
+These printers are officially supported by Rat Rig and the RatOS team.
+
+- Rat Rig V-Core Pro v1.3
+- Rat Rig V-Core 3
+- Rat Rig V-Core 3 IDEX
+- Rat Rig V-Core 4
+- Rat Rig V-Core 4 Hybrid
+- Rat Rig V-Core 4 IDEX
+- Rat Rig V-Minion
+- Rat Rig V-Chonk
+- Rat Rig V-Chonk 3Z Mod
+
+### Community Support
+
+These printers are supported through community contributions and may not be as well tested.
+
+- Prusa Mini
+- Pruse MK3S
+- Voron Design V0.1
+- Voron Design V2.4
+
 
 ## Contribute
 

diff --git a/site/docs/slicers.md b/site/docs/slicers.md
@@ -8,21 +8,22 @@
 - [IdeaMaker](#ideamaker)
 - [Slicer thumbnails](#slicer-thumbnails)
 
-# Macros
+## Macros
 
 RatOS comes with START_PRINT and END_PRINT macros that you can call directly from your slicers. This way the printer knows how to start a print, and you can there easily switch between slicers without worrying if you changed anything in another slicer.
 The g-code for these macros are found in `config/RatOS/macros.cfg`
 
-# Disable any "advanced extruder pressure" settings
+## Disable any "advanced extruder pressure" settings
+
 Some slicers advertise an "advanced extruder pressure" capability. It is recommended to keep these options disabled when using Klipper as they are likely to result in poor quality prints. Consider using Klipper's pressure advance instead.
 
 Specifically, these slicer settings can instruct the firmware to make wild changes to the extrusion rate in the hope that the firmware will approximate those requests and the printer will roughly obtain a desirable extruder pressure. Klipper, however, utilizes precise kinematic calculations and timing. When Klipper is commanded to make significant changes to the extrusion rate it will plan out the corresponding changes to velocity, acceleration, and extruder movement - which is not the slicer's intent. The slicer may even command excessive extrusion rates to the point that it triggers Klipper's maximum extrusion cross-section check.
 
 In contrast, it is okay (and often helpful) to use a slicer's "retract" setting, "wipe" setting, and/or "wipe on retract" setting.
 
-# Prusa Slicer
+## Prusa Slicer
 
-*Prusa Slicer comes with full IDEX support and is the recommended slicer for all RatRig printers.*
+_Prusa Slicer comes with full IDEX support and is the recommended slicer for all RatRig printers._
 
 :::info
 You should be using "Klipper" as the gcode flavor and have the "Use relative E distances" box checked in Printer Settings -> General -> Advanced.
@@ -114,9 +115,9 @@ Pause GCode
 PAUSE
 ```
 
-# Super Slicer
+## Super Slicer
 
-*Super Slicer supports IDEX printers, but it is not recommended to use.*
+_Super Slicer supports IDEX printers, but it is not recommended to use._
 
 :::info
 You should be using "Klipper" as the gcode flavor and have the "Only custom Start G-Code" box checked in Printer Settings -> Custom G-Code and "Use relative E distances" box checked in Printer Settings -> General -> Advanced.
@@ -159,6 +160,7 @@ START_PRINT EXTRUDER_TEMP={first_layer_temperature[0]},{first_layer_temperature[
 ```
 
 End GCode
+
 ```properties
 END_PRINT
 ```
@@ -205,9 +207,9 @@ Pause GCode
 PAUSE
 ```
 
-# Orca Slicer
+## Orca Slicer
 
-*Orca Slicer supports IDEX printers, but it is not recommended to use.*
+_Orca Slicer supports IDEX printers, but it is not recommended to use._
 
 :::info
 You should be using "Klipper" as the gcode flavor and have the "Use relative E distances" box checked in in Printer Settings -> Advance.
@@ -288,9 +290,9 @@ Pause GCode
 PAUSE
 ```
 
-# Cura
+## Cura
 
-*Cura does not support RatRig IDEX printers.*
+_Cura does not support RatRig IDEX printers._
 
 :::info
 This is the ONLY gcode you need, delete everything else. Copy paste the following **as is**.
@@ -370,9 +372,9 @@ class MeshPrintSize(Script):
 3. restart cura
 4. in cura open menu `Extensions -> Post processing -> Modify G-Code` and select `Mesh Print Size`
 
-# Simplify 3D V5
+## Simplify 3D V5
 
-*Simplify 3D does not support RatRig IDEX printers.*
+_Simplify 3D does not support RatRig IDEX printers._
 
 :::info
 This is the ONLY gcode you need, delete everything else. Copy paste the following **as is**.
@@ -390,9 +392,9 @@ End GCode
 END_PRINT
 ```
 
-# IdeaMaker
+## IdeaMaker
 
-*IdeaMaker does not support RatRig IDEX printers.*
+_IdeaMaker does not support RatRig IDEX printers._
 
 :::info
 This is the ONLY gcode you need, delete everything else. Copy paste the following **as is**.
@@ -414,6 +416,6 @@ END_PRINT
 IdeaMaker will complain there's no heating commands, you can safely ignore this.
 :::
 
-# Slicer thumbnails
+## Slicer thumbnails
 
 See the Mainsail documentation: [G-Code Thumbnails in Mainsail](https://docs.mainsail.xyz/overview/features/thumbnails)
diff --git a/site/sidebars.js b/site/sidebars.js
@@ -36,14 +36,7 @@ const sidebars = {
 			type: "category",
 			label: "Guides",
 			collapsed: false,
-			items: [
-				{ type: "autogenerated", dirName: "guides" },
-				{
-					type: "link",
-					href: "/changelog#updating-from-ratos-v1",
-					label: "Updating from RatOS V1.x",
-				},
-			],
+			items: [{ type: "autogenerated", dirName: "guides" }],
 		},
 		{
 			type: "category",

diff --git a/site/src/pages/changelog.mdx b/site/src/pages/changelog.mdx
@@ -218,7 +218,7 @@ This release mainly revolves around the new stepper/stepper driver setting recom
 
 ### General
 
-- Stepper motors, drivers and speed limits have now been made more modular, allowing for easier configuration of, for example, 48V steppers. See [Advanced Stepper Configuration](/docs/configuration/advanced-stepper-configuration) for more information.
+- Stepper motors, drivers and speed limits have now been made more modular, allowing for easier configuration of, for example, 48V steppers. See [Advanced Stepper Configuration](/docs/1.2.x/configuration/advanced-stepper-configuration) for more information.
 - Driver / Stepper settings now adopt the new recommended klipper defaults. This also means that your steppers might make a bit more noise than they did before, since the stealthchop_threshold has been set to 0. You can manually set stealthchop_threshold back to 1 if that's unacceptable to you, just be aware that it will reduce the stepper's positional accuracy.
 - Rapido and Dragonfly configs added.
 - LGX Lite config added.
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,4 +22,4 @@ build.log @@
     .*.swp
     # Ignore built docs
-    ./docs/
+    docs/**