Merge pull request #35 from Pera-Swarm/robot-documentation-refactoring

Refactoring and updates

docs/communication/communication.md → docs/communication/index.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Communication
-nav_order: 2
+nav_order: 4
 has_children: true
 permalink: communication
 ---

docs/localization/localization.md → docs/localization/index.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Localization
-nav_order: 6
+nav_order: 7
 has_children: true
 permalink: localization/
 ---

docs/robots/main/v2/firmware/0_index.md

@@ -0,0 +1,11 @@
+---
+layout: default
+title: Firmware
+parent: Main Robot (v2)
+permalink: robots/v2/firmware/
+has_children: true
+has_toc: true
+nav_order: 1
+
+gh_link: docs/robots/main/v2/firmware/0_index.md
+---

docs/robot/physical-robot/1_intro.md → docs/robots/main/v2/firmware/1_intro.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Physical Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Main Robot (v2)
 title: Robot Firmware Architecture
 nav_order: 1
-permalink: robot/physical-robot/intro
+permalink: robots/v2/firmware/intro
 
-gh_link: docs/robot/physical-robot/1_intro.md
+gh_link: docs/robots/main/v2/firmware/1_intro.md
 ---
 
 # Robot Firmware Architecture

docs/robot/physical-robot/2_motors.md → docs/robots/main/v2/firmware/2_motors.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Physical Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Main Robot (v2)
 title: Motor Library
 nav_order: 2
-permalink: robot/physical-robot/motor_library
+permalink: robots/v2/firmware/motor_library
 
-gh_link: docs/robot/physical-robot/2_motors.md
+gh_link: docs/robots/main/v2/firmware/2_motors.md
 ---
 
 # Motor Library

docs/robot/physical-robot/3_distanceSensor.md → docs/robots/main/v2/firmware/3_distanceSensor.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Physical Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Main Robot (v2)
 title: Distance Sensor Library
 nav_order: 3
-permalink: robot/physical-robot/distance_library
+permalink: robots/v2/firmware/distance_library
 
-gh_link: docs/robot/physical-robot/3_distanceSensors.md
+gh_link: docs/robots/main/v2/firmware/3_distanceSensors.md
 ---
 
 # Distance Sensor Library

docs/robot/physical-robot/4_colorSensor.md → docs/robots/main/v2/firmware/4_colorSensor.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Physical Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Main Robot (v2)
 title: Color Sensor Library
 nav_order: 4
-permalink: robot/physical-robot/color_library
+permalink: robots/v2/firmware/color_library
 
-gh_link: docs/robot/physical-robot/4_colorSensor.md
+gh_link: docs/robots/main/v2/firmware/4_colorSensor.md
 ---
 
 # Color Sensor Library

docs/robot/physical-robot/5_compass.md → docs/robots/main/v2/firmware/5_compass.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Physical Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Main Robot (v2)
 title: Compass Sensor Library
 nav_order: 5
-permalink: robot/physical-robot/compass_library
+permalink: robots/v2/firmware/compass_library
 
-gh_link: docs/robot/physical-robot/5_compass.md
+gh_link: docs/robots/main/v2/firmware/5_compass.md
 ---
 
 # Compass Sensor Library

docs/robot/physical-robot/6_ir_sensors.md → docs/robots/main/v2/firmware/6_ir_sensors.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Physical Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Main Robot (v2)
 title: IR Transceiver Library
 nav_order: 6
-permalink: robot/physical-robot/ir_library
+permalink: robots/v2/firmware/ir_library
 
-gh_link: docs/robot/physical-robot/6_ir_sensors.md
+gh_link: docs/robots/main/v2/firmware/6_ir_sensors.md
 ---
 
 # IR Transceiver Library

docs/robot/physical-robot/7_neopixel.md → docs/robots/main/v2/firmware/7_neopixel.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Physical Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Main Robot (v2)
 title: Neopixel LED Library
 nav_order: 7
-permalink: robot/physical-robot/neopixel_library
+permalink: robots/v2/firmware/neopixel_library
 
-gh_link: docs/robot/physical-robot/7_neopixel.md
+gh_link: docs/robots/main/v2/firmware/7_neopixel.md
 ---
 
 # Neopixel LED Library

docs/robot/hardware/intro.md → docs/robots/main/v2/hardware/0_intro.md

@@ -1,7 +1,8 @@
 ---
 layout: default
 title: Hardware
-parent: Robots
+parent: Main Robot (v2)
 has_children: true
+permalink: robots/v2/hardware/
 
 ---

docs/robot/hardware/schematics.md → docs/robots/main/v2/hardware/1_schematics.md

@@ -1,12 +1,12 @@
 ---
 layout: default
 parent: Hardware
-grand_parent: Robots
+grand_parent: Main Robot (v2)
 title: Schematics Diagrams
 nav_order: 1
-permalink: robot/hardware/schematics/
+permalink: robots/v2/hardware/schematics/
 
-gh_link: docs/hardware/schematics.md
+gh_link: docs/robots/main/v2/hardware/1_schematics.md
 ---
 
 # Schematics Diagrams

docs/robot/hardware/pcb.md → docs/robots/main/v2/hardware/2_pcb.md

@@ -1,12 +1,12 @@
 ---
 layout: default
 parent: Hardware
-grand_parent: Robots
+grand_parent: Main Robot (v2)
 title: PCB
 nav_order: 2
-permalink: robot/hardware/pcb/
+permalink: robots/v2/hardware/pcb/
 
-gh_link: docs/hardware/pcb.md
+gh_link: docs/robots/main/v2/hardware/2_pcb.md
 ---
 
 # PCB

docs/robot/hardware/bom.md → docs/robots/main/v2/hardware/3_bom.md

@@ -1,12 +1,12 @@
 ---
 layout: default
 parent: Hardware
-grand_parent: Robots
+grand_parent: Main Robot (v2)
 title: Bill of Materials
 nav_order: 3
-permalink: robot/hardware/bom/
+permalink: robots/v2/hardware/bom/
 
-gh_link: docs/hardware/bom.md
+gh_link: docs/robots/main/v2/hardware/3_bom.md
 ---
 
 # Bill of Materials

docs/robot/hardware/diagrams.md → docs/robots/main/v2/hardware/4_diagrams.md

@@ -1,12 +1,12 @@
 ---
 layout: default
 parent: Hardware
-grand_parent: Robots
+grand_parent: Main Robot (v2)
 title: Design Diagrams
 nav_order: 4
-permalink: robot/hardware/diagrams/
+permalink: robots/v2/hardware/diagrams/
 
-gh_link: docs/hardware/diagrams.md
+gh_link: docs/robots/main/v2/hardware/4_diagrams.md
 ---
 
 # Design Diagrams

docs/robot/robots.md → docs/robots/main/v2/index.md

@@ -1,9 +1,9 @@
 ---
 layout: default
-title: Robots
-nav_order: 2
+title: Main Robot (v2)
+nav_order: 1
 has_children: true
-permalink: robots/
+permalink: robots/main/v2/
 ---
 
 # Robots

docs/robots/obstacle/v1/firmware/0_intro.md

@@ -0,0 +1,12 @@
+---
+layout: default
+title: Firmware
+parent: Obstacle Robot (v1)
+permalink: robots/obstacle-robot/v1/firmware/
+has_children: true
+has_toc: true
+nav_order: 1
+---
+
+
+{: .no_toc }

docs/robots/obstacle/v1/hardware/0_intro.md

@@ -0,0 +1,36 @@
+---
+layout: default
+title: Hardware
+parent: Obstacle Robot (v1)
+permalink: robots/obstacle-robot/v1/hardware
+has_children: true
+has_toc: true
+nav_order: 0
+
+gh_link: docs/robots/obstacle/v1/hardware/0_intro.md
+---
+
+## Obstacle Bot Hardware
+
+{: .no_toc }
+
+![](/docs/assets/images/obstacle-bot/pictures.jpg)
+
+### Hardware Specifications 
+
+- Microcontroller: Arduino Pro Mini (16 MHz, 3.3V)
+- Power Source: 2 x Li-ion batteries
+- Motiopn
+    - Motors: N20 Motors (180 rpm)
+    - Driver: L293D
+    - Wheels: D-hole Rubber Wheel (32x7mm/3mm)
+- Communication: HC-11 Wireless Serial Port
+- Sensors
+    - MPU-6050
+- Indicators
+    - RGB LED x 1
+    - NeoPixel LED x 18
+
+### More Info
+- [Project Page - Obstacle Bots for Swarm Robots](https://cepdnaclk.github.io/e16-3yp-obstacle-bots-for-swarm-robots/)
+- [GitHub Repository](https://github.com/Pera-Swarm/e16-obstacle-bots-for-swarm-robots)

docs/robots/obstacle/v1/hardware/1_schematics.md

@@ -0,0 +1,16 @@
+---
+layout: default
+parent: Hardware
+grand_parent: Obstacle Robot (v1)
+title: Schematics Diagrams
+nav_order: 1
+permalink: robots/obstacle-robot/v1/hardware/schematics/
+
+gh_link: docs/robots/obstacle/v1/hardware/1_schematics.md
+---
+
+# Schematics Diagrams
+{: .no_toc }
+
+### Main Board
+![](/docs/assets/images/obstacle-bot/schemetic.png)

docs/robots/obstacle/v1/hardware/2_pcb.md

@@ -0,0 +1,17 @@
+---
+layout: default
+parent: Hardware
+grand_parent: Obstacle Robot (v1)
+title: PCB
+nav_order: 2
+permalink: robots/obstacle-robot/v1/hardware/pcb/
+
+gh_link: docs/robots/obstacle/v1/hardware/2_pcb.md
+---
+
+# PCB
+{: .no_toc }
+
+## Main PCB
+
+![](/docs/assets/images/obstacle-bot/pcb.jpg)

docs/robots/obstacle/v1/index.md

@@ -0,0 +1,12 @@
+---
+layout: default
+title: Obstacle Robot (v1)
+nav_order: 2
+has_children: true
+permalink: robots/obstacle-robot/v1/
+---
+
+# Obstacle Robots
+{: .no_toc }
+
+{: .fs-6 .fw-300 }

docs/robots/virtual/v1/firmware/0_intro.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Firmware
+parent: Virtual Robot (v1)
+has_children: true
+permalink: robots/virtual/firmware/v1/
+
+---

docs/robot/virtual-robot/setup-guide.md → docs/robots/virtual/v1/firmware/1_setup-guide.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Virtual Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Virtual Robot (v1)
 title: Setup Guide
 nav_order: 1
-permalink: robot/virtual-robot/setup-guide
+permalink: robots/virtual/firmware/v1/setup-guide
 
-gh_link: docs/robot/virtual-robot/setup-guide.md
+gh_link: docs/robots/virtual/v1/firmware/1_setup-guide.md
 ---
 
 # Setup Guide

docs/robot/virtual-robot/swarm-class.md → docs/robots/virtual/v1/firmware/2_swarm-class.md

@@ -1,12 +1,12 @@
 ---
 layout: default
-parent: Virtual Robot
-grand_parent: Robots
+parent: Firmware
+grand_parent: Virtual Robot (v1)
 title: Swarm Class Overview
-nav_order: 2
-permalink: robot/virtual-robot/swarm-class
+nav_order: 3
+permalink: robots/virtual/firmware/v1/swarm-class
 
-gh_link: docs/robot/virtual-robot/swarm-class.md
+gh_link: docs/robots/virtual/v1/firmware/2_swarm-class.md
 ---
 
 # Swarm Class