improve docs

Author: PaulWinterstein

docs/getting-started-guide/01_Setup_and_connect_to_Server.md

@@ -52,7 +52,7 @@ app = VideoIPathApp()
 
 # Example: Get the server version
 print(app.get_server_version())
-# > 2024.1.4
+# > 2024.4.30
 ```
 
 ## Example 2: Establishing a Connection to the VideoIPath Server via parameters
@@ -66,7 +66,7 @@ app = VideoIPathApp(server_address="10.1.100.10", username="api-user", password=
 
 # Example: Get the server version
 print(app.get_server_version())
-# > 2024.1.4
+# > 2024.4.30
 ```
 
 ## Additional Information
@@ -79,7 +79,7 @@ print(app.get_server_version())
 - `use_https`: Set to `True` if the VideoIPath Server uses HTTPS.
 - `verify_ssl_cert`: Set to `True` if the SSL certificate should be verified.
 - `log_level`: The log level for the logging module, possible values are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. If not set as a parameter or environment variable, it falls back to the root logger's level (default is set to `WARNING`).
-- `environment`: The environment of the VideoIPath Server, possible values are `DEV`, `TEST`, and `PROD` (for future use)
+- `environment`: The environment of the VideoIPath Server, possible values are `DEV` and `PROD` (for future use)
 - `advanced_driver_schema_check`: If set to `True`, the local driver schema is checked against the server's driver schema (custom settings fields).
 - `timeout_http_get`: Optional. Timeout in seconds for HTTP GET requests. Default is `10`.
 - `timeout_http_patch`: Optional. Timeout in seconds for HTTP PATCH requests. Default is `10`.
@@ -89,7 +89,7 @@ print(app.get_server_version())
 
 | Variable        | Values                                          | Description                                      |
 |-----------------|-------------------------------------------------|--------------------------------------------------|
-| `VIPAT_ENVIRONMENT`   | `DEV`, `TEST`, `PROD`                          | Optional: Define the environment. Defaults to `PROD`. |
+| `VIPAT_ENVIRONMENT`   | `DEV`, `PROD`                          | Optional: Define the environment. Defaults to `PROD`. |
 | `VIPAT_VIDEOIPATH_SERVER_ADDRESS` | e.g. IP `10.200.10.21` or hostname `vip.company.com` | IP address or hostname of the VideoIPath server. |
 | `VIPAT_VIDEOIPATH_USERNAME` | e.g. `api_user`                               | Username for the API User.                      |
 | `VIPAT_VIDEOIPATH_PASSWORD` | e.g. `very_strong_passw0rd`                    | Password for the API User.                      |

docs/getting-started-guide/02_Inventory.md

@@ -309,6 +309,8 @@ File content:
 In this example the configuration was changed in the GUI after the backup was made.
 
 ```python
+from videoipath_automation_tool.apps.inventory.model import InventoryDevice
+
 with open("gtw_31_config.json", "r") as file:
     gtw_31_config = json.load(file)
 
@@ -382,7 +384,7 @@ print(f"Device '{duplicated_device.configuration.label}' with id '{duplicated_de
 # > Device 'Hello World' with id 'device1' duplicated in Inventory!")
 ```
 
-#### 2.4.1 Clone a device
+#### 2.4.2 Clone a device on the same VideoIPath instance
 
 ```python
 # Get the device with the user defined label "Hello World" from the inventory

docs/getting-started-guide/03_Topology.md

@@ -76,7 +76,7 @@ A device can be removed from the topology using its device ID.
 app.topology.remove_device_by_id(device_id="device10")
 ```
 
-### 3. Accessing Vertices and Edges
+## 3. Working with Vertices and Edges
 
 It is possible to either iterate through all vertices/edges of a category, which is often useful for bulk operations, or access individual vertices/edges directly by their ID or label.
 
@@ -123,9 +123,9 @@ print(vertice_video_ip_in_1_1.id)
 # > device80.1.3000000
 ```
 
-### 3.2. Example: Configure existing Edges/Vertices
+### 3.4. Example: Configure existing Edges/Vertices
 
-#### 3.2.1. Configure Codec Vertices based on information from factory labels
+#### 3.4.1. Configure Codec Vertices based on information from factory labels
 
 ```python
 device = app.topology.get_device(device_id="device80")
@@ -177,7 +177,7 @@ More examples will be added soon!
 
 ---
 
-## 3.3. Createing external Edges between devices
+### 3.5. Creating external Edges between devices
 
 ```python
 virtuoso_device_id = "device80"
@@ -188,7 +188,7 @@ spine_blue_device_id = "device1"
 edges_red_slot_1 = app.topology.create_edges(
     device_1_id=virtuoso_device_id,
     device_1_vertex_factory_label="Ethernet 1.3",
-    device_2_id=spine_red,
+    device_2_id=spine_red_device_id,
     device_2_vertex_factory_label="Ethernet29",
     bandwidth=10000,
     bandwidth_factor=0.9,
@@ -197,7 +197,7 @@ edges_red_slot_1 = app.topology.create_edges(
 edges_blue_slot_1 = app.topology.create_edges(
     device_1_id=virtuoso_device_id,
     device_1_vertex_factory_label="Ethernet 1.4",
-    device_2_id=spine_blue,
+    device_2_id=spine_blue_device_id,
     device_2_vertex_factory_label="Ethernet29",
     bandwidth=10000,
     bandwidth_factor=0.9,
@@ -218,4 +218,4 @@ virtuoso_topology.configuration.external_edges.extend(edges_blue_slot_1)
 app.topology.update_device(device=virtuoso_topology)
 ```
 
-## The documentation is currently being expanded. Upcoming sections will include details on device positioning, virtual device management, and device comparison, as well as synchronization status and various helper functions
+> **Note:** The documentation is currently being expanded. Upcoming sections will include details on device positioning, virtual device management, and device comparison, as well as synchronization status and various helper functions.

docs/getting-started-guide/04_Multicast_Pools.md

@@ -1,6 +1,6 @@
 # System Preferences: Multicast Pools
 
-## Tipp: Define a variable for the allocation_pools_config for easier access
+## Tip: Define a variable for the allocation_pools_config for easier access
 
 ```python
 allocation_pools_config = app.preferences.system_configuration.allocation_pools
@@ -54,7 +54,7 @@ available_ranges=['A', 'B', 'default']
 id='B' vid='B' ranges=[Range(startip=IPv4Address('234.0.0.0'), endip=IPv4Address('234.255.255.254')), Range(startip=IPv4Address('236.0.0.1'), endip=IPv4Address('236.0.0.2'))] utilization=Utilization(percentage=0, total=16777215, used=0)
 ```
 
-# Code Example 4: Remove a range from a pool
+## Code Example 4: Remove a range from a pool
 
 ```python
 b_range = allocation_pools_config.get_multicast_range_by_name("B")
@@ -75,18 +75,18 @@ After Removal:
 available_ranges=['A', 'B', 'default']
 ```
 
-# Code Example 5: Delete a pool
+## Code Example 5: Delete a pool
 
 ```python
 # Can be done either by range name or the range object itself
 allocation_pools_config.remove_multicast_range("B")
 ```
 
-# Code Example 6: Use Information to validate a vertex configuration
+## Code Example 6: Use Information to validate a vertex configuration
 
 ```python
 # The implementation of Inspect-Topology GUI allows to set invalid multicast pools.
-# => Tipp: Use Information to validate a vertex configuration
+# => Tip: Use Information to validate a vertex configuration
 from videoipath_automation_tool.apps.topology.model.n_graph_elements.topology_codec_vertex import nPoolId
 
 allocation_pools_config = app.preferences.system_configuration.allocation_pools

docs/getting-started-guide/05_Profile.md

@@ -1,11 +1,10 @@
 # Getting Started Guide
 
-This guide will help you get started with the VideoIPath Automation Tool. It will show you how to establish a connection to the VideoIPath server and how to manage devices in the inventory and topology. Also, it demonstrates how to configure multicast pools and profiles.
+This guide will help you get started with the VideoIPath Automation Tool. It will show you how to establish a connection to the VideoIPath server and how to manage devices in the inventory and topology. Also, it demonstrates how to configure multicast pools.
 
 ## Table of Contents
 
 1. [Establishing a Connection to the VideoIPath Server](01_Setup_and_connect_to_Server.md)
 2. [Managing Devices in the Inventory](02_Inventory.md)
 3. [Managing Devices in the Topology](03_Topology.md)
 4. [Configuring Multicast Pools](04_Multicast_Pools.md)
-5. [Configuring Profiles](05_Profile.md)