Feat: updated docs

docs/.vitepress/config.mjs

@@ -8,15 +8,19 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: 'Algorithms', link: '/processing_algorithms/directions_from_points_1_layer' }
     ],
 
     sidebar: [
       {
-        text: 'Examples',
+        text: 'Algorithms',
         items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
+          { text: 'Directions from Points (1)', link: '/processing_algorithms/directions_from_points_1_layer' },
+          { text: 'Directions from Points (2)', link: '/processing_algorithms/directions_from_points_2_layers' },
+          { text: 'Directions from Polylines Layer', link: '/processing_algorithms/directions_from_polylines_layer' },
+          { text: 'Isochrones from Layer', link: '/processing_algorithms/isochrones_from_layer' },
+          { text: 'Isochrones from Point', link: '/processing_algorithms/isochrones_from_point' },
+          { text: 'Matrix from Layers', link: '/processing_algorithms/matrix_from_layers' }
         ]
       }
     ],

docs/index.md

@@ -8,18 +8,39 @@ hero:
   tagline: My great project tagline
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
-    - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: Processing Algorithms
+      link: /processing_algorithms/directions_from_points_1_layer
 
 features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
----
+  - title: Installation and Setup
+    details: Get step-by-step instructions on how to install and configure the ORStools plugin within your QGIS environment.
+    link: https://github.com/GIScience/orstools-qgis-plugin/wiki/ORS-Tools-Help
+
+  - title: Usage
+    details: Learn how to efficiently utilize the main features and functionalities of the ORStools plugin to streamline your workflow within QGIS.
+    link: https://github.com/Merydian/orstools-wiki-test/wiki/usage
+
+  - title: Developer Information
+    details: Get detailed instructions on setting up your development environment for ORStools QGIS plugin.
+    link: https://github.com/GIScience/orstools-qgis-plugin/blob/main/README.md
+
+  - title: Forum for more general questions
+    details: Connect with fellow users, share your experiences, and seek assistance by accessing our dedicated forum for Openrouteservice discussions.
+    link: https://ask.openrouteservice.org/c/sdks/qgis
+
+  - title: Issue Tracker
+    details: Report any bugs, suggest improvements, or track ongoing issues through our issue tracker to ensure a smooth user experience (for advanced users).
+    link: https://github.com/GIScience/orstools-qgis-plugin/issues
+
+  - title: OSM Tags
+    details: Gain insights into the OpenStreetMap tags utilized by the Openrouteservice to customize routing profiles according to your specific requirements.
+    link: https://giscience.github.io/openrouteservice/technical-details/tag-filtering#tag-filtering
+
+  - title: ORS Interactive Documentation
+    details: Access interactive documentation resources to better understand the capabilities and functionalities of the openrouteservice API integrated into the ORStools plugin.
+    link: https://openrouteservice.org/dev/#/api-docs
 
+  - title: ORS Restrictions
+    details: Stay informed about any restrictions or limitations associated with the openrouteservice API, ensuring accurate planning and analysis within QGIS.
+    link: https://openrouteservice.org/restrictions/
+---

docs/processing_algorithms/directions_from_points_1_layer.md

@@ -0,0 +1,126 @@
+# Directions from 1 Point-Layer
+This algorithm calculates optimal routes for (Multi)Point layers. 
+
+<img src="/wiki/img/directions_from_points_1_layer_toolbox.png" alt="Toolbox">
+
+## Parameters
+
+### Provider
+First, you'll have to [sign-up](https://openrouteservice.org/sign-up) and register your API key in your [dashboard](https://openrouteservice.org/dev/#/home).
+
+In the configuration window (`Web` > `ORS Tools` > `Configuration`) you have set up the API key, which will be saved locally in a configuration file and will automatically be used across all tools. Here you can also set the base URL in case you're using a self-hosted ORS version and the requests per minute you're allocated (usually set to 40).
+
+![ORS Tools configuration](/wiki/img/wiki_orstools_config.png)
+
+
+<details>
+<summary>Get your API Key from Openrouteservice.org by signing up and going to your dashboard.</summary>
+<br>
+
+[![How To: Api Key](http://img.youtube.com/vi/Rsxl_0IUSFM/0.jpg)](http://www.youtube.com/watch?v=Rsxl_0IUSFM?start=145 "ORSTools 1.2 for Routing, Isochrones and Travel Time in QGIS") 
+
+</details>
+
+### Travel Mode
+Select mode of travel.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+ <li>driving-car</li>
+ <li>driving-hgv</li>
+ <li>cycling-regular</li>
+ <li>cycling-road</li>
+ <li>cycling-mountain</li>
+ <li>cycling-electric</li>
+ <li>foot-walking</li>
+ <li>foot-hiking</li>
+ <li>wheelchair</li>
+</ul>
+</details>
+<br>
+
+A detailed description of this can be viewed [here](https://giscience.github.io/openrouteservice/technical-details/travel-speeds/#travel-time-calculation)
+
+### Input Layer
+Choose a Point or MultiPoint layer as Input.
+
+### Layer ID Field
+These Values will transfer to the output layer and can be used to join layers or group features afterwards.
+
+### Sort Points
+Before running the algorithm points are sorted by the values of this field (Be aware of the field type! Text fields will be sorted as 1,13,2,D,a,x)
+
+### Travel preference
+Dictates the cost. For longer routes don't use Shortest Path.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+ <li>fastest</li>
+ <li>shortest</li>
+ <li>recommended</li>
+</ul>
+</details>
+<br>
+
+[comment]: <> (Gibt's hiervon irgenwo Erklärungen, die man beifügen oder verlinken könnte?)
+
+### Traveling Salesman
+You can optionally perform a [Traveling Salesman Optimization](https://en.wikipedia.org/wiki/Travelling_salesman_problem) on the waypoints of each (Multi)Point feature. Enabling Traveling Salesman will erase all other advanced configuration and assume the preference to be fastest.
+
+<details>
+<summary>Examples</summary>
+<br>
+<h4>Traveling Salesman Problem: Round trip</h4>
+<img src="/wiki/img/tsp_round_trip.png" alt="Traveling Salesman Problem: Round trip">
+<h4>Traveling Salesman Problem: fix start point</h4>
+<img src="/wiki/img/tsp_fix_start_point.png" alt="Traveling Salesman Problem: fix start point">
+<h4>Traveling Salesman Problem: fix end point</h4>
+<img src="/wiki/img/tsp_fix_end_point.png" alt="Traveling Salesman Problem: fix end point">
+<h4>Traveling Salesman Problem: fix start and end points</h4>
+<img src="/wiki/img/tsp_fix_start_and_end_points.png" alt="Traveling Salesman Problem: fix start and end points">
+</details>
+
+### Directions(Output)
+Specify a path, where the layer will be saved. Leaving this empty will result in a temporary layer. 
+
+## Advanced Parameters
+These are optional parameters you can use to avoid certain areas.
+
+### Features to Avoid
+You can make your route avoid particular features. Specify them here.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+  <li>Highways</li>
+  <li>Tollways</li>
+  <li>Ferries</li>
+  <li>Fords</li>
+  <li>Steps</li>
+</ul>
+</details>
+<br>
+
+### Types of borders to avoid
+Specify which type of border crossing to avoid.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+  <li>all</li>
+  <li>controlled</li>
+</ul>
+</details>
+<br>
+
+### Comma-separated list of ids of countries to avoid
+List of countries to exclude from route with driving-* profiles. Can be used together with 'avoid_borders': 'controlled'. [ 11, 193 ] would exclude Austria and Switzerland. List of countries and application examples can be found [here](https://giscience.github.io/openrouteservice/technical-details/country-list). Also, ISO standard country codes cna be used in place of the numerical ids, for example, DE or DEU for Germany.
+
+### Polygons to avoid
+You can make your route avoid particular polygons from your layers. Specify them here.

docs/processing_algorithms/directions_from_points_2_layers.md

@@ -0,0 +1,118 @@
+# Directions from 2 Point-Layers
+This algorithm calculates optimal routes for multiple start and end points based on the input files.
+
+<img src="/wiki/img/directions_from_points_2_layers_toolbox.png" alt="Toolbox">
+
+## Parameters
+
+### Provider
+First, you'll have to [sign-up](https://openrouteservice.org/sign-up) and register your API key in your [dashboard](https://openrouteservice.org/dev/#/home).
+
+In the configuration window (`Web` > `ORS Tools` > `Configuration`) you have set up the API key, which will be saved locally in a configuration file and will automatically be used across all tools. Here you can also set the base URL in case you're using a self-hosted ORS version and the requests per minute you're allocated (usually set to 40).
+
+![ORS Tools configuration](/wiki/img/wiki_orstools_config.png)
+
+<details>
+<summary>Get your API Key from Openrouteservice.org by signing up and going to your dashboard.</summary>
+<br>
+
+[![How To: Api Key](http://img.youtube.com/vi/Rsxl_0IUSFM/0.jpg)](http://www.youtube.com/watch?v=Rsxl_0IUSFM?start=145 "ORSTools 1.2 for Routing, Isochrones and Travel Time in QGIS")
+
+</details>
+
+### Travel Mode
+Select mode of travel.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+ <li>driving-car</li>
+ <li>driving-hgv</li>
+ <li>cycling-regular</li>
+ <li>cycling-road</li>
+ <li>cycling-mountain</li>
+ <li>cycling-electric</li>
+ <li>foot-walking</li>
+ <li>foot-hiking</li>
+ <li>wheelchair</li>
+</ul>
+</details>
+
+A detailed description of this can be viewed [here](https://giscience.github.io/openrouteservice/technical-details/travel-speeds/#travel-time-calculation)
+
+### Input Start Point Layer
+Select a point layer (Not MultiPoint) to serve as starting points for the route calculation. 
+
+### Start ID Field
+Select a field that will be appended to the output route layer, to later be able to [join](https://docs.qgis.org/3.34/en/docs/user_manual/working_with_vector/joins_relations.html) it with the input start point layer.
+
+### Sort start points by
+Select a field to sort start layer points by. The correspondence between startpoints and endpoints is specified by this order (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x).
+
+### Input Endpoint Layer
+Select a point layer (Not MultiPoint) to serve as ending points for the route calculation.
+
+### End ID Field
+Select a field that will be appended to the output route layer, to later be able to [join](https://docs.qgis.org/3.34/en/docs/user_manual/working_with_vector/joins_relations.html) it with the input end point layer.
+
+### Sort End Points by
+Select a field to sort end layer points by. The correspondence between endpoints and startpoints is specified by this order (Be aware of the field type! Text fields will be sorted like 1,13,2,D,a,x).
+
+### Travel Preference
+Dictates the cost. For longer routes don't use Shortest Path.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+ <li>fastest</li>
+ <li>shortest</li>
+ <li>recommended</li>
+</ul>
+</details>
+<br>
+
+### Layer Mode
+Either 'row-by-row' until one layers has no more features or 'all-by-all' for every feature combination.
+
+### Directions(Output)
+Specify a path, where the layer will be saved. Leaving this empty will result in a temporary layer. 
+
+## Advanced Parameters
+These are optional parameters you can use to avoid certain areas.
+
+### Features to Avoid
+You can make your route avoid particular features. Specify them here.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+  <li>Highways</li>
+  <li>Tollways</li>
+  <li>Ferries</li>
+  <li>Fords</li>
+  <li>Steps</li>
+</ul>
+</details>
+<br>
+
+### Types of borders to avoid
+Specify which type of border crossing to avoid.
+
+<details>
+<summary>Options</summary>
+<br>
+<ul>
+  <li>all</li>
+  <li>controlled</li>
+</ul>
+</details>
+<br>
+
+### Comma-separated list of ids of countries to avoid
+List of countries to exclude from route with driving-* profiles. Can be used together with 'avoid_borders': 'controlled'. [ 11, 193 ] would exclude Austria and Switzerland. List of countries and application examples can be found [here](https://giscience.github.io/openrouteservice/technical-details/country-list). Also, ISO standard country codes cna be used in place of the numerical ids, for example, DE or DEU for Germany.
+
+### Polygons to avoid
+You can make your route avoid particular polygons from your layers. Specify them here.