Skip to content

Commit

Permalink
Docs updated according to the new Dev Env settings window (but images…
Browse files Browse the repository at this point in the history
… are not yet included).
  • Loading branch information
janosmurai committed Mar 28, 2024
1 parent 731a2e0 commit d66bed6
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 26 deletions.
25 changes: 3 additions & 22 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,14 @@ Arguments:

Create a new Development Environment descriptor and save it to the local descriptor storage (catalog).

Running this command will open up an interactive UI on the command line. Follow the steps below to
configure the new Environment.

1. First you need to select the tool 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 types with :material-keyboard-space:. Select next if you finished the selection.
Running this command will open up the Dev Env settings window:

![tool select](wp-content/tool_select.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:.

![image select](wp-content/image_select.png)

:info: After creation, the Development Environment can be installed with the `install` command.

Arguments:
Expand All @@ -71,7 +64,7 @@ will be asked if they want to overwrite it or not.

Arguments:

`DEV_ENV_NAME` Name of the Development Environment, whose descriptor to clone. [required]
`DEV_ENV_NAME` Clone the descriptor of the Dev Env. [required]

---

Expand All @@ -88,28 +81,16 @@ Arguments:

## **`dem modify DEV_ENV_NAME`**

Change a tool in a Development Environment.

If the tool type is not specified, the Dev Env settings panel will be opened:

1. The dem shows a list of the already selected tools. You can modify the selection. You can
navigate with the :material-arrow-up: and :material-arrow-down: or :material-alpha-k: and
:material-alpha-j: keys. Modify the required tool types with :material-keyboard-space:. Select next
when you're done with the selection.

![tool select](wp-content/tool_select.png)
Open the Development Environment settings window to modify the Development Environment descriptor.

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:.

![image select](wp-content/image_select.png)

Arguments:

`DEV_ENV_NAME` Name of the Development Environment to modify. [required]
`[TOOL_TYPE]` The tool type to change. [optional]
`[TOOL_IMAGE]` The tool image to set for the tool type. [optional]

---

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ catalog, which you can modify to your needs. You might want to:
- Add/remove tools.
- Change the tool image for a given tool.

You can edit it with the Development Environment settings view:
You can edit it with the Development Environment settings window:

dem modify DEV_ENV_NAME

Expand Down
7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ extra:
provider: mike

copyright: >
Copyright 2023 - axem solutions - All rights reserved |
Copyright 2024 - axem solutions - All rights reserved |
<a href="#__consent">Change cookie settings</a> |
Made with <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>
Expand All @@ -75,8 +75,9 @@ markdown_extensions:
- pymdownx.details
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg


nav:
- 'index.md'
Expand Down

0 comments on commit d66bed6

Please sign in to comment.