Docs updated. Dev Env Setting Window hint panel fixed.

Author: janosmurai

dem/cli/tui/window/dev_env_settings_window.py

@@ -5,17 +5,16 @@
 from dem.cli.tui.printable_tool_image import PrintableToolImage
 from rich.panel import Panel
 from rich.layout import Layout
-from rich.console import Group
 from rich.align import Align
 from rich.live import Live
 from rich.table import Table
 from readchar import readkey, key
 
 class NavigationHint(Panel):
     hint_text = """
-- [bold]move cursor[/]: arrows or vi mode
-- [bold]select[/]: space or enter
-- [bold]jump to save/cancel[/]: tab
+- [bold]move cursor[/]: up and down arrows or j and k keys
+- [bold]toggle selection[/]: space or enter
+- [bold]jump between save/cancel and the selector[/]: tab
 """
     def __init__(self) -> None:
         super().__init__(self.hint_text, title="Navigation", expand=False)

docs/commands.md

@@ -36,15 +36,21 @@ Arguments:
 
 Create a new Development Environment descriptor and save it to the local descriptor storage (catalog).
 
-Running this command will open up the Dev Env settings window:
+Running this command will open up the Dev Env Settings Window:
 
-    ![tool select](wp-content/tool_select.png)
+![Dev Env Settings Window](wp-content/dev_env_settings_window.png)
 
-2. Assign the required tool images for the selected types. You can navigate with the
-:material-arrow-up: and :material-arrow-down: or :material-alpha-k: and :material-alpha-j: keys.
-Select the required tool image and press :material-keyboard-return:.
+The table on the left shows the available tool types. Select the ones you want to use in the 
+Development Environment. You can navigate with the :material-arrow-up: and :material-arrow-down: or 
+:material-alpha-k: and :material-alpha-j: keys. Move the cursor to the tool image you would like to 
+select or deselect  and press the :material-keyboard-return:. 
+On the right side, you can see the tool images that are selected.
 
-:info: After creation, the Development Environment can be installed with the `install` command.
+When the Dev Env is ready, press :material-keyboard-return: on the `save` button.
+
+!!! info 
+
+    After creation, the Development Environment can be installed with the `install` command.
 
 Arguments:
 
@@ -81,12 +87,23 @@ Arguments:
 
 ## **`dem modify DEV_ENV_NAME`**
 
-Open the Development Environment settings window to modify the Development Environment descriptor.
+Modify a Development Environment descriptor available from the local descriptor storage (catalog).
+
+Running this command will open up the Dev Env Settings Window, prefilled with the current selection:
+
+![Dev Env Settings Window](wp-content/dev_env_settings_window.png)
+
+The table on the left shows the available tool types. Select the ones you want to use in the 
+Development Environment. You can navigate with the :material-arrow-up: and :material-arrow-down: or 
+:material-alpha-k: and :material-alpha-j: keys. Move the cursor to the tool image you would like to 
+select or deselect  and press the :material-keyboard-return:. 
+On the right side, you can see the tool images that are selected.
+
+When the Dev Env is ready, press :material-keyboard-return: on the `save` button.
 
-2. Assign the required tool images for the selected types. You can navigate with the
-:material-arrow-up: and :material-arrow-down: or :material-alpha-k: and :material-alpha-j: keys.
-Select the required tool image and press :material-keyboard-return:.
+!!! info 
 
+    After the modification, the Development Environment can be installed with the `install` command.
 
 Arguments:
 

docs/index.md

@@ -15,6 +15,16 @@ containerized Development Environments.**
     Learn by doing! Try our [tutorial](https://www.axemsolutions.io/tutorial/index.html) 
     with a simple embedded project!
 
+## Pain points DEM solves
+- Slow and error-prone setup of Development Environments -> **Quick and reproducible installation** 
+with a single command
+- "It works on my machine" -> **Consistent Development Environments** for every developer
+- Modifying the toolset is hard and time-consuming -> **Easy and scalable Dev Env management** where 
+the tools are like building blocks
+- Devs get out of flow and waste time and motivation configuring the tools -> Devs can **focus on 
+their actual work**
+- Vendor specific interfaces -> **Standardized Development Environments**
+
 ## Concept
 
 ### :unlock: Loose coupling between tools

docs/installation.md

@@ -11,9 +11,13 @@ To use the DEM on your PC, you need to have the following tools installed:
 
 ## Installation
 
-Use the following install script to get the latest version of DEM:  
+You can download the installer script from the root of the repository:
 
-    `curl -fsSL 'https://raw.githubusercontent.com/axem-solutions/dem/main/install-dem.sh' | bash`
+    curl -O https://raw.githubusercontent.com/axem-solutions/dem/main/install-dem.sh
+
+If you are happy with the content of the script, you can execute it:
+
+    bash install-dem.sh
 
 ### Alternative installation
 

docs/quickstart.md

@@ -15,7 +15,6 @@ You can clone the selected template with:
 
     dem clone DEV_ENV_NAME
 
-
 ## I'd like to work on a project already configured with DEM...
 
 In this case you only need to initialize the Dev Env with: