Add new Documentation for Contributing New Blocks (#256)

* Update website home page * Update documentation page to give more relevant info * Update top nav-bar * Add developer names * Add skeleton of basic tutorial * Add new getting_started example * Fix typo * Update HomePage to reflect new getting started page * Updates for getting started * Add basic info about contributing new blocks * Rename files and add sample request * Add Vacuum Cleaner Exercise * Add index page to link to solved exercises * Add subheading * Change Follow Road to Exercises * Improve style of tutorials page
JdeRobot · Nov 6, 2023 · 7c44305 · 7c44305
1 parent c32f4d0
commit 7c44305
Show file tree

Hide file tree

Showing 12 changed files with 568 additions and 7 deletions.
diff --git a/docs/_pages/custom_contribute.md b/docs/_pages/custom_contribute.md
@@ -0,0 +1,39 @@
+---
+title: Custom Blocks
+layout: posts
+permalink: /custom_contribute/
+
+collection: posts
+
+classes: narrow
+
+sidebar:
+  nav: "docs"
+---
+
+Thanks for taking the time to contribute blocks to Visual Circuit's Library.
+To create a block and add it, simply follow the steps given below:
+
+## Creating the block
+Create the block in Visual Circuit and test it in your custom environment
+
+## Save As
+![Save As]({{ "assets/images/custom_contribute/save_as.png" | absolute_url }})
+
+## Add as Block
+![Add Block]({{ "assets/images/custom_contribute/add_block.png" | absolute_url }})
+
+![Sample Block]({{ "assets/images/custom_contribute/sample_block.png" | absolute_url }})
+
+## Example of Added Block Display
+![Block Added]({{ "assets/images/custom_contribute/block_added.png" | absolute_url }})
+
+
+## Contributing upstream
+Create a Pull Request on the VisualCircuit-resources repo. The Pull Request must include: 
+- Content of the blocks as a .vc3 file,
+- An explantion of its utility 
+- A short video of its working 
+- Expected input and output
+
+![Sample Request]({{ "assets/images/custom_contribute/sample_request.png" | absolute_url }})
diff --git a/docs/_pages/exercises.md b/docs/_pages/exercises.md
@@ -0,0 +1,24 @@
+---
+title: Exercises
+layout: posts
+permalink: /exercises/
+
+collection: posts
+
+classes: narrow
+
+sidebar:
+  nav: "docs"
+---
+
+A list of sample exercises of Robotics Academy solved using VisualCircuit are:
+
+### Tutorials
+
+1. [Follow Road](/follow_road/)
+2. [Vacuum Cleaner with FSM](/vacuum_cleaner)
+
+### YouTube Links:
+
+1. [Labyrinth Escape](https://www.youtube.com/watch?v=Xs3iAPYRtVQ&list=PLGlX46StCA-SKzpnScwDv4D8_zeVadaOY&index=12)
+2. [Visual Lander](https://www.youtube.com/watch?v=J1JhnNOKe1o&list=PLGlX46StCA-SKzpnScwDv4D8_zeVadaOY&index=13)
diff --git a/docs/_pages/home.md b/docs/_pages/home.md
@@ -43,10 +43,10 @@ feature_row:
     btn_label: "Learn more"
 
   - image_path: /assets/images/follow_road/follow_road.jpg
-    alt: "Follow Road"
-    title: "Follow Road"
-    excerpt: "Solving the Follow Road Excercise with Visual Circuit"
-    url: "/follow_road/"
+    alt: "Exercises"
+    title: "Exercises"
+    excerpt: "Robotics Academy Exercises Solved with VisualCircuit"
+    url: "/exercises/"
     btn_class: "btn--primary"
     btn_label: "Learn more"
 

diff --git a/docs/_pages/tutorials.md b/docs/_pages/tutorials.md
@@ -11,10 +11,12 @@ sidebar:
   nav: "docs"
 ---
 
-## Designing an application on VisualCircuit3
+## 1. Designing an application on VisualCircuit3
 
 {% include video id="uK725Y-Y9_c" provider="youtube" %}
 
-## Building a custom block on VisualCircuit3
+## 2. Building a custom block on VisualCircuit3
 
-{% include video id="haW_oEOjKh8" provider="youtube" %}
+{% include video id="haW_oEOjKh8" provider="youtube" %}
+
+## 3. [For a detailed guide on how to contribute custom blocks](/custom_contribute)