Skip to content

Commit e2c472a

Browse files
committed
docs: improve clarity and consistency in user documentation
1 parent 511aba4 commit e2c472a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/user-documentation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ The following environment variables are used to configure Arduino App CLI:
1515
| `DOCKER_PYTHON_BASE_IMAGE` | `app-bricks/python-apps-base:<RUNNER_VERSION>` | Tag of the Docker image for the Python runner |
1616

1717
## Directory Structures
18-
Examples of user-defined apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder.
18+
Examples of user-defined Arduino Apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder.
1919
```
2020
├── my-first-app
2121
│   ├── app.yaml
2222
│   ├── README.md
2323
│   ├── python
2424
│   │   └── main.py
25-
│   sketch
25+
│   ├── sketch
2626
│   │ ├── sketch.ino
2727
│   │ └── sketch.yaml
2828
| └── .cache/ # Temporary files and dependencies
2929
└── my-second-app
3030
├── app.yaml
3131
├── python
32-
   └── main.py
32+
   └── main.py
3333
```
3434

3535
Examples of the `assets` and the builtin `examples` stored into the `ARDUINO_APP_CLI__DATA_DIR` folder.
@@ -39,12 +39,12 @@ Examples of the `assets` and the builtin `examples` stored into the `ARDUINO_APP
3939
├── assets
4040
│   └── 0.5.0 # Version-specific assets
4141
│   ├── bricks-list.yaml # Available bricks
42-
│   ├── models-list.yaml # Available models
42+
│   ├── models-list.yaml # Available models
4343
│   └── ...
4444
├── bootloader_burned.flag
45-
├── default.app
46-
├── properties.msgpack # Variable values
47-
├── examples
45+
├── default.app # Default App
46+
├── properties.msgpack # Variable values
47+
├── examples # Built-in App examples
4848
│   ├── air-quality-monitoring
4949
│   │   ├── app.yaml
5050
│   │   ├── assets

0 commit comments

Comments
 (0)