Minor fixes to TOC & formatting (#102)

Added Layout to Electronics manual TOC, adjusted nav orders to suit this; some small unrelated formatting and typo fixes too.
VzBoT3D · Oct 11, 2023 · 0687925 · 0687925
1 parent e16d359
commit 0687925
Show file tree

Hide file tree

Showing 25 changed files with 51 additions and 40 deletions.
diff --git a/docs/faq.md b/docs/faq.md
@@ -56,7 +56,7 @@ If you are from China / Asia, we understand that buying and shipping a printhead
 
 You are free to design and produce your own iteration of the VzBoT aluminum parts. Please note that commercial redistribution and production will violate the CC BY-NC 4.0 license of the project!
 
-![](./assets/images/faq/vzprinthead.jpg)
+![Vz-Printhead showcase](./assets/images/faq/vzprinthead.jpg)
 
 ## What is AWD (All wheel drive)?
 

diff --git a/docs/general/misc-info/print-settings.md b/docs/general/misc-info/print-settings.md
@@ -21,7 +21,7 @@ Parts such as motor mounts, bed frame braces, etc.
 | Layer height               | **0.2mm**                                         |
 | Line width                 | **0.4-0.6mm**                                     |
 | Outside perimiters (walls) | **4**                                             |
-| Top/bottom layers:         | **5**                                             |
+| Top/bottom layers          | **5**                                             |
 | Infill                     | **40-50%** cubic, triangular, gyroid or honeycomb |
 
 ## For motion parts
@@ -33,5 +33,5 @@ Parts such as the carriage and X gantry joint, etc.
 | Layer height               | **0.2mm**                                         |
 | Line width                 | **0.4-0.6mm**                                     |
 | Outside perimiters (walls) | **4**                                             |
-| Top/bottom layers:         | **5**                                             |
+| Top/bottom layers          | **5**                                             |
 | Infill                     | **30-40%** cubic, triangular, gyroid or honeycomb |
diff --git a/docs/vz235_mellow/bottom_panels.md b/docs/vz235_mellow/bottom_panels.md
@@ -5,7 +5,7 @@ parent: Vz235 - Mellow Kit
 has_toc: false
 nav_order: 4
 has_children: false
-permalink: /vz235_mellow/panels_part1
+permalink: /vz235_mellow/bottom_panels
 redirect_from:
   - /vz235_alu/panels_part1
 ---

diff --git a/docs/vz235_mellow/frame.md b/docs/vz235_mellow/frame.md
@@ -16,7 +16,7 @@ redirect_from:
 
 ![Frame](../assets/images/manual/vz235_printed/frame/overview.png)
 
-The frame is assembled through a combination of blind joints, corner brackets and blind corner brackets. The corner brackets are to help stiffen up the frame and are optional, though we highly recommend using them on every possible corner for best results.
+The frame is assembled through a combination of blind joints, reinforcing corner brackets and blind corner brackets. The reinforcing corner brackets are to help stiffen up the frame and are optional, though we highly recommend using them on every possible corner for best results.
 
 For detailed informations on how to assemble blind joints visit this [page](../general/misc-info/blind-joints)
 

diff --git a/docs/vz235_mellow/gantry.md b/docs/vz235_mellow/gantry.md
@@ -14,7 +14,7 @@ redirect_from:
 
 ## Overview
 
-The Gantry is configurable for an AWD version and a 2WD version. The only difference between the two configurations is the rear idler mounts. On AWD they have an additional Nema 17 integrated in the design.
+The gantry is configurable for an AWD version and a 2WD version. The only difference between the two configurations is the rear idler mounts. On AWD they have an additional Nema 17 integrated in the design.
 
 ![Overview](../../../assets/images/manual/vz235_mellow/gantry/overview.png)
 

diff --git a/docs/vz235_mellow/z_assembly_bed.md b/docs/vz235_mellow/z_assembly_bed.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: 2. Z - Assembly & Bed
+title: 2. Z-assembly & Bed
 parent: Vz235 - Mellow Kit
 has_toc: false
 nav_order: 2
@@ -10,7 +10,7 @@ redirect_from:
   - /vz235_alu/z_assembly
 ---
 
-# 2. Z - Assembly & Bed
+# 2. Z-assembly & Bed
 
 ## Overview
 

diff --git a/docs/vz235_mellow/z_assembly_bed/bed_additions.md b/docs/vz235_mellow/z_assembly_bed/bed_additions.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: 2.5 Z-Switch & bed chain
-parent: 2. Z - Assembly & Bed
+parent: 2. Z-assembly & Bed
 grand_parent: Vz235 - Mellow Kit
 has_toc: false
 nav_order: 5

diff --git a/docs/vz235_mellow/z_assembly_bed/bed_assembly.md b/docs/vz235_mellow/z_assembly_bed/bed_assembly.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: 2.2 Bed Assembly
-parent: 2. Z - Assembly & Bed
+parent: 2. Z-assembly & Bed
 grand_parent: Vz235 - Mellow Kit
 has_toc: false
 nav_order: 2

diff --git a/docs/vz235_mellow/z_assembly_bed/lower_part.md b/docs/vz235_mellow/z_assembly_bed/lower_part.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: 2.1 Lower rod & leadscrew bracket
-parent: 2. Z - Assembly & Bed
+parent: 2. Z-assembly & Bed
 grand_parent: Vz235 - Mellow Kit
 has_toc: false
 nav_order: 1

diff --git a/docs/vz235_mellow/z_assembly_bed/top_rod_mounts.md b/docs/vz235_mellow/z_assembly_bed/top_rod_mounts.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: 2.3 Top rod mounts
-parent: 2. Z - Assembly & Bed
+parent: 2. Z-assembly & Bed
 grand_parent: Vz235 - Mellow Kit
 has_toc: false
 nav_order: 3

diff --git a/docs/vz235_mellow/z_assembly_bed/z_motor.md b/docs/vz235_mellow/z_assembly_bed/z_motor.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: 2.4 Z-Motor bracket
-parent: 2. Z - Assembly & Bed
+parent: 2. Z-assembly & Bed
 grand_parent: Vz235 - Mellow Kit
 has_toc: false
 nav_order: 4

diff --git a/docs/vz235_printed/bottom_panels.md b/docs/vz235_printed/bottom_panels.md
@@ -5,7 +5,7 @@ parent: Vz235 - Printed Version
 has_toc: false
 nav_order: 4
 has_children: false
-permalink: /vz235_printed/panels_part1
+permalink: /vz235_printed/bottom_panels
 ---
 
 # 4. Bottom and rear panels

diff --git a/docs/vz235_printed/gantry.md b/docs/vz235_printed/gantry.md
@@ -12,7 +12,7 @@ permalink: /vz235_printed/gantry
 
 ## Overview
 
-The Gantry is configurable for an AWD version and a 2WD version. The major differences between the two configurations are the rear idler mounts. On AWD configurations, they have additional NEMA17 stepper motors integrated in the design, replacing the idler bearings.
+The gantry is configurable for an AWD version and a 2WD version. The major differences between the two configurations are the rear idler mounts. On AWD configurations, they have additional NEMA17 stepper motors integrated in the design, replacing the idler bearings.
 
 ![Gantry](../../assets/images/manual/vz235_printed/printed_preview_md.png)
 

diff --git a/docs/vz235_printed/index.md b/docs/vz235_printed/index.md
@@ -7,7 +7,7 @@ has_children: true
 permalink: /vz235_printed
 ---
 
-# VzBoT235 - Printed Version Version
+# VzBoT235 - Printed Version
 
 ![Overview](../assets/images/manual/vz235_printed/printed_preview.png)
 
@@ -21,7 +21,7 @@ On how to print the files for this printer please refer to [print settings](../g
 We advice to build the printer in the following order:
 
 1. [Frame](./vz235_printed/frame)
-2. [Z - Assembly & Bed](./vz235_printed/z_assembly)
+2. [Z-assembly & Bed](./vz235_printed/z_assembly)
 3. [Gantry](./vz235_printed/gantry)
 4. [Bottom and rear panel](./vz235_printed/bottom_panels)
 5. [Fume extractor](./vz235_printed/fume_extractor)
@@ -31,4 +31,4 @@ We advice to build the printer in the following order:
 
 ## Video tutorial
 
-[**Vz235 AWD** by Vez3D](/video-tutorials/vz235-awd/){: .btn .doc-link } 
+[**Vz235 AWD** by Vez3D](/video-tutorials/vz235-awd/){: .btn .doc-link }
diff --git a/docs/vz235_printed/z_assembly_bed.md b/docs/vz235_printed/z_assembly_bed.md
@@ -1,6 +1,6 @@
 ---
 layout: default
-title: 2. Z - Assembly & Bed
+title: 2. Z-assembly & Bed
 parent: Vz235 - Printed Version
 has_toc: false
 nav_order: 2

diff --git a/docs/vz330_mellow/bottom_panels.md b/docs/vz330_mellow/bottom_panels.md
@@ -5,7 +5,7 @@ parent: Vz330 - Mellow Kit
 has_toc: false
 nav_order: 5
 has_children: false
-permalink: /vz330_mellow/panels_part1
+permalink: /vz330_mellow/bottom_panels
 ---
 
 # 5. Bottom and rear panels

diff --git a/docs/vz330_mellow/electronics.md b/docs/vz330_mellow/electronics.md
@@ -14,11 +14,11 @@ This is a general overview of the parts recommended for a VzBoT build. Everyone
 We trust everyone to use their own best judgement when wiring their printer, we do not recommend to do this without professional help if you are inexperienced in electronics.
 
 1. [Wiring diagram](/vz330_mellow/electronics/diagram)
-2. *Layout*
+2. *Layout* (WIP)
 3. [Mellow Super8 v1.3](/vz330_mellow/electronics/super_mellow)
 4. [Firmware](/vz330_mellow/electronics/Firmware)
 5. [Printer config](/vz330_mellow/electronics/Printer_Config)
-6. [Display](/vz330_mellow/electronics/display)
+6. [Wiring diagram](/vz330_mellow/electronics/diagram)
 
 ![Overview](../../assets/images/manual/vz330_mellow/electronics/overview.png)
 

diff --git a/docs/vz330_mellow/electronics/Mellow Super8 V1.3.md b/docs/vz330_mellow/electronics/Mellow Super8 V1.3.md
@@ -1,15 +1,15 @@
 ---
 layout: default
-title: 6.2 Mellow Super8 v1.3
+title: 6.3 Mellow Super8 v1.3
 parent: 6. Electronics
 grand_parent: Vz330 - Mellow Kit
 has_toc: false
-nav_order: 2
+nav_order: 3
 has_children: false
 permalink: /vz330_mellow/electronics/super_mellow
 ---
 
-# 6.2 Mellow Super8 V1.3
+# 6.3 Mellow Super8 V1.3
 
 ## Setup guide
 

diff --git a/docs/vz330_mellow/electronics/Printer Config.md b/docs/vz330_mellow/electronics/Printer Config.md
@@ -1,15 +1,15 @@
 ---
 layout: default
-title: 6.4 Printer Config
+title: 6.5 Printer Config
 parent: 6. Electronics
 grand_parent: Vz330 - Mellow Kit
 has_toc: false
-nav_order: 4
+nav_order: 5
 has_children: false
 permalink: /vz330_mellow/electronics/Printer_Config
 ---
 
-# 6.4 Setting up the Printer.cfg
+# 6.5 Setting up the Printer.cfg
 
 Now comes the fun part of the setup. Configuring your printer.cfg.
 

diff --git a/docs/vz330_mellow/electronics/diagram.md b/docs/vz330_mellow/electronics/diagram.md
@@ -1,14 +1,14 @@
 ---
 layout: default
-title: 6.5 Wiring Diagram
+title: 6.6 Wiring Diagram
 parent: 6. Electronics
 grand_parent: Vz330 - Mellow Kit
 has_toc: false
-nav_order: 4
+nav_order: 6
 has_children: false
 permalink: /vz330_mellow/electronics/diagram
 ---
 
-# 6.5 Wiring Diagram
+# 6.6 Wiring Diagram
 
 [![Wiring diagram vz330](https://raw.githubusercontent.com/VzBoT3D/VzBoT-Vz330/master/Wiring%20Diagram/VZBOT%20330%20WIRING%20DIAGRAM%20AWD%20WITH%20CPAP.png)](https://raw.githubusercontent.com/VzBoT3D/VzBoT-Vz330/master/Wiring%20Diagram/VZBOT%20330%20WIRING%20DIAGRAM%20AWD%20WITH%20CPAP.png)
diff --git a/docs/vz330_mellow/electronics/firmware.md b/docs/vz330_mellow/electronics/firmware.md
@@ -1,15 +1,15 @@
 ---
 layout: default
-title: 6.3 Firmware Setup
+title: 6.4 Firmware Setup
 parent: 6. Electronics
 grand_parent: Vz330 - Mellow Kit
 has_toc: false
-nav_order: 3
+nav_order: 4
 has_children: false
 permalink: /vz330_mellow/electronics/Firmware
 ---
 
-# 6.3 Firmware Setup
+# 6.4 Firmware Setup
 
 Time to start flashing our Pi and Motherboard.
 

diff --git a/docs/vz330_mellow/electronics/layout.md b/docs/vz330_mellow/electronics/layout.md
@@ -0,0 +1,11 @@
+---
+layout: default
+title: 6.2 Electronics layout
+parent: 6. Electronics
+grand_parent: Vz330 - Mellow Kit
+has_toc: false
+nav_order: 2
+has_children: false
+nav_exclude: true
+slug: layout
+---
diff --git a/docs/vz330_mellow/index.md b/docs/vz330_mellow/index.md
@@ -19,8 +19,7 @@ For guidance on printing the printed parts for this printer, please refer to the
 
 We advice to build the printer in the following order:
 
-0. [Inspect kit contents](/vz330_mellow/kit_contents)
-1. <small>W.I.P.</small>
+1. [Inspect kit contents](/vz330_mellow/kit_contents)
 2. [Build the frame](/vz330_mellow/frame)
 3. [Z-Assembly & Bed](/vz330_mellow/z_assembly)
 4. [X/Y Gantry](/vz330_mellow/gantry)

diff --git a/docs/vz330_mellow/kit_contents.md b/docs/vz330_mellow/kit_contents.md
@@ -1,9 +1,9 @@
 ---
 layout: default
-title: Kit contents
+title: 6.1 Kit contents
 parent: Vz330 - Mellow Kit
 has_toc: false
-nav_order: 0
+nav_order: 1
 has_children: false
 permalink: /vz330_mellow/kit_contents
 ---

diff --git a/docs/vz330_mellow/printed_parts.md b/docs/vz330_mellow/printed_parts.md
@@ -3,9 +3,10 @@ layout: default
 title: 1. Print plates
 parent: Vz330 - Mellow Kit
 has_toc: false
-nav_order: 1
+#nav_order: 1
+nav_exclude: true
 has_children: false
-permalink: /vz330_mellow/print_plates
+#permalink: /vz330_mellow/print_plates
 ---
 
 TODO