diff options
| -rw-r--r-- | docs/Config_Changes.md | 2 | ||||
| -rw-r--r-- | docs/FAQ.md | 2 | ||||
| -rw-r--r-- | docs/Overview.md | 2 | ||||
| -rw-r--r-- | docs/_klipper3d/mkdocs.yml | 27 |
4 files changed, 15 insertions, 18 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md index e4a74c6c..1894fad9 100644 --- a/docs/Config_Changes.md +++ b/docs/Config_Changes.md @@ -1,4 +1,4 @@ -# Configuration changes +# Configuration Changes This document covers recent software changes to the config file that are not backwards compatible. It is a good idea to review this diff --git a/docs/FAQ.md b/docs/FAQ.md index a68bbd06..7724d2c9 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,4 +1,4 @@ -# Frequently asked questions +# Frequently Asked Questions 1. [How can I donate to the project?](#how-can-i-donate-to-the-project) 2. [How do I calculate the rotation_distance config parameter?](#how-do-i-calculate-the-rotation_distance-config-parameter) diff --git a/docs/Overview.md b/docs/Overview.md index 7d712433..632f584e 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -14,7 +14,7 @@ may require users to update their printer config file. - [Contact](Contact.md): Information on bug reporting and general communication with the Klipper developers. -## Configuration and Tuning Guides +## Installation and Configuration - [Installation](Installation.md): Guide to installing Klipper. - [Config Reference](Config_Reference.md): Description of config diff --git a/docs/_klipper3d/mkdocs.yml b/docs/_klipper3d/mkdocs.yml index 0333b26f..bf8f1908 100644 --- a/docs/_klipper3d/mkdocs.yml +++ b/docs/_klipper3d/mkdocs.yml @@ -14,14 +14,12 @@ markdown_extensions: - toc: permalink: True toc_depth: 6 - #- pymdownx.snippets - attr_list - mdx_partial_gfm - mdx_truly_sane_lists - mdx_breakless_lists plugins: - search - - section-index - mkdocs-simple-hooks: hooks: on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" @@ -72,20 +70,19 @@ extra: # Navigation hierarchy (this should mimic the layout of Overview.md) nav: - - Overview: - - Overview.md - - Features.md - - FAQ.md - - Releases.md - - Config_Changes.md - - Contact.md - - Configuration and Tuning: + - Overview.md + - Features.md + - FAQ.md + - Releases.md + - Config_Changes.md + - Contact.md + - Installation and Configuration: - Installation.md - - Configuration reference: + - Configuration Reference: - Config_Reference.md - Rotation_Distance.md - Config_checks.md - - Bed level: + - Bed Level: - Bed_Level.md - Delta_Calibrate.md - Probe_Calibrate.md @@ -93,7 +90,7 @@ nav: - Manual_Level.md - Bed_Mesh.md - Endstop_Phase.md - - Resonance compensation: + - Resonance Compensation: - Resonance_Compensation.md - Measuring_Resonances.md - Pressure_Advance.md @@ -105,7 +102,7 @@ nav: - skew_correction.md - Using_PWM_Tools.md - G-Codes.md - - Developer documentation: + - Developer Documentation: - Code_Overview.md - Kinematics.md - Protocol.md @@ -116,7 +113,7 @@ nav: - Benchmarks.md - CONTRIBUTING.md - Packaging.md - - Device specific documents: + - Device Specific Documents: - Example_Configs.md - SDCard_Updates.md - RPi_microcontroller.md |