added logos and more structure

naturerobots · Dec 9, 2024 · 12311ad · 12311ad
1 parent 92a9c33
commit 12311ad
Show file tree

Hide file tree

Showing 21 changed files with 137 additions and 81 deletions.
diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -0,0 +1 @@
+# Guides
diff --git a/docs/index.md b/docs/index.md
@@ -1,55 +1,40 @@
 <div align="center" min-width=519px>
-  <img src="/media/mesh_navigation_logo.png" alt="Mesh Navigation" height=150 />  
+  <img src="media/mesh_nav_logo.png" alt="Mesh Navigation" height=200 />  
 </div>
 <h4 align="center">Mesh Navigation Documentation</h4>
-<div align="center">
-  <a href="https://github.com/naturerobots/mesh_navigation">Code</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/naturerobots/mesh_tools">Mesh Tools</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/naturerobots/move_base_flex">Move Base Flex</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://www.youtube.com/@nature-robots">Videos</a>
 
-  <br />
+<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;" >
+    <iframe src="https://www.youtube.com/embed/gvKsW5MEC4Y?si=WohSZ_lEdIbxAZZK?autoplay=1&mute=1" 
+            title="YouTube Video" 
+            frameborder="0" 
+            allow="autoplay; encrypted-media" 
+            allowfullscreen 
+            style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;">
+    </iframe>
 </div>
 
+<br/>
 
 # Documentation
 
-
 This documentation is under construction. It will contain both explanations for more applied users and for developers.
 
 ## Table of Contents
 
 This documentation cosists of several examples, guides and conceptual explanations to give users a more thourough understanding of [mesh_navigation](https://github.com/naturerobots/mesh_navigation).
 
-**Mesh Navigation**
+**Getting Started**
 
 - [Overview](/index.md)
 - [Installation](/installation.md)
+- [Run](/run.md)
 
-**Theory**
-- [Why Meshes?](/theory/mesh_maps.md)
-
-**Tutorials**
-
-Guides:
-1. [Mesh Mapping](/tutorials/mesh_mapping.md)
-2. [Cost Layers Generation](/tutorials/cost_layer_generation.md)
-3. [Localization](/tutorials/localization.md)
-4. [Mesh Navigation](/tutorials/mesh_navigation.md)
-5. [Deliberation](/tutorials/deliberation.md)
-
-**Library**
-
-Writing own plugins for
-- [Cost Layer](/library/cost_layer_plugin.md)
-- [Planner](/library/planner_plugin.md)
-- [Controller](/library/controller_plugin.md)
+**Documentation**
 
-**Guides**
-TODO
+- [Theory](/theory/index.md)
+- [Tutorials](tutorials/index.md)
+- [Library](/library/index.md)
+- [Guides](/guides/index.md)
 
 ## Contributions
 

diff --git a/docs/library/controller_plugin.md b/docs/library/controller_plugin.md
@@ -0,0 +1 @@
+# Controller Plugin
diff --git a/docs/library/cost_layer_plugin.md b/docs/library/cost_layer_plugin.md
@@ -0,0 +1 @@
+# Cost Layer Plugin
diff --git a/docs/library/index.md b/docs/library/index.md
@@ -0,0 +1,3 @@
+# Library
+
+TODO: More in-depth library overview
diff --git a/docs/library/planner_plugin.md b/docs/library/planner_plugin.md
@@ -0,0 +1 @@
+# Planner Plugin
diff --git a/docs/media/mesh_nav_icon.png b/docs/media/mesh_nav_icon.png
diff --git a/docs/media/mesh_nav_icon_bg_white.png b/docs/media/mesh_nav_icon_bg_white.png
diff --git a/docs/media/mesh_navigation_logo.png → docs/media/mesh_nav_logo.png b/docs/media/mesh_navigation_logo.png → docs/media/mesh_nav_logo.png
diff --git a/docs/run.md b/docs/run.md
diff --git a/docs/static/stylesheets/style.css b/docs/static/stylesheets/style.css
@@ -0,0 +1,6 @@
+.youtube-container {
+    position: relative;
+    padding-bottom: 56.25%;
+    height: 0;
+    overflow: hidden;
+}
diff --git a/docs/theory/index.md b/docs/theory/index.md
@@ -0,0 +1 @@
+# Overview
diff --git a/docs/tutorials/cost_layer_generation.md b/docs/tutorials/cost_layer_generation.md
@@ -16,9 +16,7 @@ Some useful cost layers are already implemented such as
 - height difference
 - border
 
-All these layers are described in [mesh navigation](https://github.com/naturerobots/mesh_navigation). In addition, [mesh navigation](https://github.com/naturerobots/mesh_navigation) provides simple interfaces to implement own kinds of cost layers. This [article](./OwnCostLayer) describes the usage of this interface in greater detail.
-
-
+All these layers are described in [mesh navigation](https://github.com/naturerobots/mesh_navigation). In addition, [mesh navigation](https://github.com/naturerobots/mesh_navigation) provides simple interfaces to implement cost layers as plugins which is described here: [Link](/tutorials/plugins/own_cost_layer.md).
 
 ## Initial Cost Layer Generation
 

diff --git a/docs/tutorials/deliberation.md b/docs/tutorials/deliberation.md
@@ -1,14 +1,6 @@
 # Deliberation
 
-
 This guide aims to provide tutorials explaining the integration of mesh navigation into well-known deliberation approaches such as behavior trees, etc.
 
-
-
-
 TODO!
 
-
-
-
-
diff --git a/docs/tutorials/editing/align_mesh_to_ground.md b/docs/tutorials/editing/align_mesh_to_ground.md
@@ -0,0 +1,15 @@
+# Align Mesh to Ground Plane
+
+*TODO*: Write something
+
+Link: [https://www.youtube.com/watch?v=FUYHixJfYQs](https://www.youtube.com/watch?v=FUYHixJfYQs)
+
+<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;" >
+    <iframe src="https://www.youtube.com/embed/FUYHixJfYQs?si=ynbYgaeIH83Kb_VH?autoplay=1&mute=1" 
+            title="YouTube Video" 
+            frameborder="0" 
+            allow="autoplay; encrypted-media" 
+            allowfullscreen 
+            style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;">
+    </iframe>
+</div>
diff --git a/docs/tutorials/editing/flatten_surface.md b/docs/tutorials/editing/flatten_surface.md
@@ -0,0 +1,30 @@
+
+# Mesh Editing: Flatten a surface
+
+*TODO*: Rewrite this
+
+
+Due to sensor inaccuracies flat floors sometimes are mapped roughly...
+
+
+straightened out the ground plane using Blender: 
+
+1. enable ortographic view (numpad 5), 
+2. look from the side (numpad 3),
+3. enable X-Ray (Alt-z),
+4. box select vertices,
+5. manually fix the selection, 
+6. then scale z to 0 (s z 0)
+
+Link: [https://www.youtube.com/watch?v=TmKt9RFphf0](https://www.youtube.com/watch?v=TmKt9RFphf0)
+
+<div style="position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden;" >
+    <iframe src="https://www.youtube.com/embed/TmKt9RFphf0?si=6uekXnyqvFDrmYnz?autoplay=1&mute=1" 
+            title="YouTube Video" 
+            frameborder="0" 
+            allow="autoplay; encrypted-media" 
+            allowfullscreen 
+            style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;">
+    </iframe>
+</div>
+
diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
@@ -1,43 +1,38 @@
-<div align="center" min-width=519px>
-  <img src="/media/mesh_navigation_logo.png" alt="Mesh Navigation" height=150 />  
-</div>
-<h4 align="center">Tutorials of Mesh Navigation</h4>
-<div align="center">
-  <a href="https://github.com/naturerobots/mesh_navigation_tutorials">Code</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/naturerobots/mesh_navigation">Mesh Navigation</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/naturerobots/mesh_tools">Mesh Tools</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/naturerobots/move_base_flex">Move Base Flex</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://www.youtube.com/@nature-robots">Videos</a>
-
-  <br />
-</div>
-
-
-# Documentation
+
+# Tutorials
 
 This documentation is under construction. It will contain both explanations for more applied users and for developers.
 
 ## Applied Users
 explanations on how to start things (in more detail than the README.md)
 Link existing docs of mesh_navigation. e.g. wiki-page where all the implemented layers are explained.  
 
-Installation:
+Overview:
 
-Guides:
 1. [Mesh Mapping](/tutorials/mesh_mapping.md)
 2. [Cost Layers Generation](/tutorials/cost_layer_generation.md)
 3. [Localization](/tutorials/localization.md)
 4. [Mesh Navigation](/tutorials/mesh_navigation.md)
 5. [Deliberation](/tutorials/deliberation.md)
 
+
+Mesh Generation:
+
+- TODO
+
+Mesh Editing:
+
+- [Flatten Floor](/tutorials/editing/flatten_surface.md)
+- [Align Mesh to Ground](/tutorials/editing/align_mesh_to_ground.md)
+
+
+
 ## Mesh Navigation for Developer
 instructions how to change certain things for developing new things. Explain concepts in more detail.
 
-TODO
+Writing Plugins:
 
+- [Own Costmap](/tutorials/plugins/own_cost_layer.md)
+- TODO
 
 
diff --git a/docs/tutorials/own_cost_layer.md → docs/tutorials/plugins/own_cost_layer.md b/docs/tutorials/own_cost_layer.md → docs/tutorials/plugins/own_cost_layer.md
diff --git a/docs/tutorials/worlds/real_world.md b/docs/tutorials/worlds/real_world.md
@@ -0,0 +1,3 @@
+# Real World Worlds
+
+TODO
diff --git a/docs/tutorials/worlds/simple.md b/docs/tutorials/worlds/simple.md
@@ -0,0 +1,7 @@
+# Simple Worlds
+
+Locations:
+- Maps: `mesh_navigation_tutorials/maps`
+- Worlds: `mesh_navigation_tutorials_sim/worlds`
+
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,16 +6,19 @@ repo_url: https://github.com/naturerobots/mesh_navigation
 
 docs_dir: docs
 theme:
-    name: material
-    features:
-      - navigation.instant
-      - navigation.tabs
-      - navigation.sections
-      - navigation.footer
-    logo: resources/img/mesh_nav_logo.png
-    favicon: resources/img/mesh_nav_icon.png
-    palette:
-      primary: blue
+  name: material
+  features:
+    - navigation.instant
+    - navigation.tabs
+    - navigation.sections
+    - navigation.footer
+  logo: media/mesh_nav_icon_bg_white.png
+  favicon: media/mesh_nav_icon.png
+  palette:
+    primary: blue
+
+extra_css:
+  - static/stylesheets/style.css
 
 markdown_extensions:
   - pymdownx.highlight
@@ -34,17 +37,31 @@ nav:
     - Overview: index.md
     - Installation: installation.md
   - Theory:
+    - Overview: theory/index.md
     - Why Meshes: theory/mesh_maps.md
   - Tutorials:
     - Overview: tutorials/index.md
-    - Mesh Mapping: tutorials/mesh_mapping.md
-    - Cost Layers Generation: tutorials/cost_layer_generation.md
-    - Localization: tutorials/localization.md
-    - Mesh Navigation: tutorials/mesh_navigation.md
-    - Deliberation: tutorials/deliberation.md
+    - General:
+      - Overview: tutorials/index.md
+      - Mesh Mapping: tutorials/mesh_mapping.md
+      - Cost Layers Generation: tutorials/cost_layer_generation.md
+      - Localization: tutorials/localization.md
+      - Mesh Navigation: tutorials/mesh_navigation.md
+      - Deliberation: tutorials/deliberation.md
+    - Worlds:
+      - Simple: tutorials/worlds/simple.md
+      - Real-World: tutorials/worlds/real_world.md
+    - Mesh Editing:
+      - Flatten Surfaces: tutorials/editing/flatten_surface.md
+      - Align Mesh to Ground: tutorials/editing/align_mesh_to_ground.md
+    - Writing Plugins:
+      - Own Cost Layer: tutorials/plugins/own_cost_layer.md
   - Library:
+    - Overview: library/index.md
     - Cost Layer Plugin: library/cost_layer_plugin.md
     - Planner Plugin: library/planner_plugin.md
     - Controller Plugin: library/controller_plugin.md
+  - Guides:
+    - Overview: guides/index.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Library

		TODO: More in-depth library overview