Add Robotics Project Master Guide

- Add Robotics Project master guide
- Add support for MermaidJS diagrams
- Add content to topic stub pages

Author: kaiyun717

.ruby-version

@@ -1 +1 @@
-2.7.8
+3.2.2

Gemfile

@@ -13,6 +13,7 @@ end
 
 gem "nokogiri", ">= 1.10.8"
 gem "kramdown", ">= 2.3.0"
+gem 'webrick', "~> 1.7"
 gem "minimal-mistakes-jekyll"
 
 

Gemfile.lock

@@ -267,6 +267,7 @@ GEM
       unf_ext
     unf_ext (0.0.9.1)
     unicode-display_width (1.8.0)
+    webrick (1.9.0)
 
 PLATFORMS
   ruby
@@ -281,6 +282,7 @@ DEPENDENCIES
   kramdown (>= 2.3.0)
   minimal-mistakes-jekyll
   nokogiri (>= 1.10.8)
+  webrick (~> 1.7)
 
 BUNDLED WITH
    2.1.4

README.md

@@ -54,7 +54,7 @@ The Robotics Knowledgebase makes use of the following:
 
 ### Directories
 The wiki itself is contained in the `/wiki` folder. The `/docs` folder exists to contain future documentation on contributing and supporting the wiki. The wiki contains the following categories:
-- **Actuation**
+- **Controls & Actuation**
   - Topics related to the moving components including motors and controls.
 - **Common Platforms**
   - Covers common hardware and software frameworks used in robotics. ROS is included here.

_config.yml

@@ -165,6 +165,9 @@ kramdown:
   toc_levels: 1..6
   smart_quotes: lsquo,rsquo,ldquo,rdquo
   enable_coderay: false
+  parse_block_html: true
+  syntax_highlighter_opts:
+    disable: true
 
 
 # Search

_data/navigation.yml

@@ -9,7 +9,26 @@ wiki:
       - title: Wiki Index
         url: /wiki/
       - title: Contribute
-        url: /docs/
+        url: /docs/index/
+  - title: Robotics Project Guide
+    url: /wiki/robotics-project-guide/master-guide/
+    children:
+      - title: Define your goals and requirements
+        url: /wiki/robotics-project-guide/define-your-goals-and-requirements/
+      - title: Choose a robot
+        url: /wiki/robotics-project-guide/choose-a-robot/
+      - title: Make a robot
+        url: /wiki/robotics-project-guide/make-a-robot/
+      - title: Choose a language (or languages)
+        url: /wiki/robotics-project-guide/choose-a-language/
+      - title: Robot communication
+        url: /wiki/robotics-project-guide/choose-comm/
+      - title: Choose a simulator
+        url: /wiki/robotics-project-guide/choose-a-sim/
+      - title: Test and debug your robot
+        url: /wiki/robotics-project-guide/test-and-debug/
+      - title: Demo day!
+        url: /wiki/robotics-project-guide/demo-day/
   - title: System Design & Development
     url: /wiki/system-design-development/
     children:
@@ -120,7 +139,7 @@ wiki:
         url: /wiki/sensing/azure-block-detection/
       - title: DWM1001 UltraWideband Positioning System
         url: /wiki/sensing/ultrawideband-beacon-positioning.md
-  - title: Actuation
+  - title: Controls & Actuation
     url: /wiki/actuation/
     children:
       - title: Motor Controller Feedback
@@ -365,7 +384,7 @@ docs:
       - title: Wiki Index
         url: /wiki/
       - title: Contribute
-        url: /docs/
+        url: /docs/index/
   - title: Contribute
     children:
       - title: Introduction

_includes/mermaid.html

@@ -0,0 +1,10 @@
+<script src="https://unpkg.com/mermaid@11.4.0/dist/mermaid.min.js"></script>
+<script>
+  $(document).ready(function () {
+    mermaid.initialize({
+      startOnLoad:true,
+      theme: "default",
+    });
+    window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
+  });
+</script>

_includes/scripts.html

@@ -51,3 +51,15 @@
    });
 </script>
 {% endif %}
+
+<script src="https://unpkg.com/mermaid@11.4.0/dist/mermaid.min.js"></script>
+<script>
+  $(document).ready(function () {
+    mermaid.initialize({
+      startOnLoad:true,
+      theme: "default",
+    });
+    window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
+  });
+</script>
+ 

about.md

@@ -14,6 +14,7 @@ To accelerate the development of both projects and individual skills, we need an
 *This* is that knowledge base. Here, you will find guidance on the full spectrum of our field.
 
 ### Where should I start?
+This wiki is meant for people in various stages of their career, including absolute beginners. If you are just starting out in robotics, we recommend you to start from [Robotics Project Guide](wiki/robotics-project-guide/master-guid). This tutorial talks about what to consider and plan for in each step of a robotics project and provides ample resources.
 
 ### How can I contribute?