Updating Documentation for RSS2024

Major rework of documentation

Co-authored-by: Deepana Ishtaweera <[email protected]>

.devcontainer/devcontainer.json

@@ -0,0 +1,6 @@
+{
+	"name": "Jekyll",
+	"image": "mcr.microsoft.com/devcontainers/jekyll:2.7-bullseye",
+	"postCreateCommand": "bundle install --gemfile=${containerWorkspaceFolder}/docs/Gemfile",
+	"postStartCommand": "jekyll serve --livereload -s ${containerWorkspaceFolder}/docs"
+}

docs/Gemfile

@@ -0,0 +1,39 @@
+gem "just-the-docs"
+
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.2.2"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+  gem 'jekyll-relative-links'
+  gem "jekyll-remote-theme"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+
+gem "webrick"

docs/_config.yml

@@ -1,6 +1,39 @@
 title: ETHZ RobotX SuperMegaBot
 description: Documentation of the SuperMegaBot
-# theme: just-the-docs
 remote_theme: just-the-docs/just-the-docs
 markdown: kramdown
 color_scheme: RobotX
+
+
+enable_copy_code_button: true
+
+
+relative_links:
+  enabled: true
+
+
+callouts_level: quiet # or loud
+callouts:
+  highlight:
+    color: yellow
+  important:
+    title: Important
+    color: blue
+  new:
+    title: New
+    color: green
+  note:
+    title: Note
+    color: yellow
+  warning:
+    title: Warning
+    color: red
+
+
+# Favicon settings
+favicon_ico: favicon.ico
+
+
+plugins:
+  - jekyll-remote-theme
+  - jekyll-relative-links

docs/_sass/custom/custom.scss

@@ -24,3 +24,12 @@
   border-radius: 5px;
   background-color: #fffdf6;
 }
+
+.smb-info-green {
+  max-width: auto;
+  margin: 1em;
+  padding: 10px 10px 10px 36px;
+  border: 1px solid #aeffae;
+  border-radius: 5px;
+  background-color: #f6fff9;
+}

docs/additional-software/index.md

@@ -1,22 +1,34 @@
 ---
 layout: default
 title: Additional Software
-nav_order: 10
-has_children: true
+nav_order: 9
+has_children: false
+has_toc: false
 ---
 
-# Additional software
+# 🛠️ Additional Software
 
 {:.no_toc}
-This page introduces some additional software that can be used to simplify or help using the SuperMegaBot.
+This page introduces some additional software that can simplify or assist in using the SuperMegaBot.
 
 * Table of contents
 {:toc}
 
-## Mission Planner
+## 📋 Mission Planner
 
-A mission plan defines the logic how and when different missions are executed. The mission plan is implemented as a smach state machine. Each mission has its own mission data, containing relevant information for the mission (e.g. its waypoints). For more explanation please refer to the [MissionPlanner](https://github.com/ETHZ-RobotX/smb_mission_planner).
+A mission plan defines the logic of how and when different missions are executed. The mission plan is implemented as a smach state machine. Each mission has its own mission data, containing relevant information for the mission (e.g., its waypoints). For more details, please refer to the [MissionPlanner](https://github.com/ETHZ-RobotX/smb_mission_planner).
 
-## NodeManager
+## 📚 Some Notions
 
-When running the full software stack on the robot, a lot of ROS nodes are run simultaneously. [NodeManager](HowToUseNodeManager.md) can help in launching and monitoring the current status of each node.
+### 🌐 Git 
+Git is software for tracking changes in any set of files, usually used for coordinating work among programmers collaboratively developing source code during software development. Its goals include speed, data integrity, and support for distributed, non-linear workflows (thousands of parallel branches running on different systems).
+
+For more info, please refer to this [link](https://medium.com/@itswisdomagain/git-101-introduction-to-git-for-newbies-bb14f6f9fc1).
+
+### 🖥️ Ubuntu Terminal 
+The Linux command line is a text interface to your computer. Often referred to as the shell, terminal, console, prompt, or various other names, it can appear complex and confusing to use.
+
+For more info, please refer to this [link](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview).
+
+#### 📤 Export 
+`export` is a command in the Bash shell language. When used to set a variable, the variable (e.g., `PATH`) will be visible ("exported to") to any subprocesses started from that instance of Bash. Without the `export` command, the variable will not exist in the subprocess.