Skip to content

Commit 50c3cf7

Browse files
committed
docs: improve formatting and clarity in environment variables section
1 parent 1643009 commit 50c3cf7

File tree

3 files changed

+18
-15
lines changed

3 files changed

+18
-15
lines changed

Taskfile.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,6 @@ tasks:
145145
- git tag -a "{{.CLI_ARGS}}" -m "Release {{.CLI_ARGS}}"
146146
- git push origin "{{.CLI_ARGS}}"
147147

148-
149-
150148
# To to forward a port, using ssh, you can use this command:
151149
# ssh -L 8800:localhost:8800 arduino@<BOARD_IP>
152150
arduino-app-cli:pprof:

docs/contributor-guide/development.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@ Checks and tests are set up to ensure the project content is functional and comp
3030
- `task test`
3131

3232
## Installing arduino-app-cli into the board
33+
3334
This is reccomended way to test a local development version of the arduino-app-cli into a board.
34-
1. Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
35-
1. `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested.
35+
36+
1. Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
37+
1. `task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested.
3638

3739
## Automatic Corrections
3840

@@ -41,8 +43,9 @@ Tools are provided to automatically bring the project into compliance with some
4143
- `task lint`
4244
- `task fmt`
4345

44-
4546
## Generate API docs
47+
4648
If a PR, change the HTTP API definitions, the following steps are needed:
49+
4750
1. Open the `cmd/gendoc/docs.go` and modify/add/remove the definitions
4851
1. Run `task doc` to generate the docs (i.e., the files `internal/api/docs/openapi.yaml` and `internal/e2e/client/client.gen.go` are generated)

docs/user-documentation.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44

55
The following environment variables are used to configure Arduino App CLI:
66

7-
| Environment Variable | Default Value | Description |
8-
|---------------------|---------------|-------------|
9-
| `ARDUINO_APP_CLI__APPS_DIR` | `/home/arduino/ArduinoApps` | Path to the directory where Arduino Apps created by the user are stored |
10-
| `ARDUINO_APP_CLI__DATA_DIR` | `/home/arduino/.local/share/arduino-app-cli` | Path to the directory where internal data is stored (examples, assets, properties) |
11-
| `ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR` | `$HOME/.arduino-bricks/ei-models` | Path to the directory where custom AI models are stored |
12-
| `ARDUINO_APP_CLI__ALLOW_ROOT` | `false` | Allow running `arduino-app-cli` as root (**Not recommended to set to true**) |
13-
| `LIBRARIES_API_URL` | `https://api2.arduino.cc/libraries/v1/libraries` | URL of the external service used to search Arduino libraries |
14-
| `DOCKER_REGISTRY_BASE` | `ghcr.io/arduino/` | Docker registry used to pull docker images |
15-
| `DOCKER_PYTHON_BASE_IMAGE` | `app-bricks/python-apps-base:<RUNNER_VERSION>` | Tag of the Docker image for the Python runner |
7+
| Environment Variable | Default Value | Description |
8+
| -------------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------- |
9+
| `ARDUINO_APP_CLI__APPS_DIR` | `/home/arduino/ArduinoApps` | Path to the directory where Arduino Apps created by the user are stored |
10+
| `ARDUINO_APP_CLI__DATA_DIR` | `/home/arduino/.local/share/arduino-app-cli` | Path to the directory where internal data is stored (examples, assets, properties) |
11+
| `ARDUINO_APP_BRICKS__CUSTOM_MODEL_DIR` | `$HOME/.arduino-bricks/ei-models` | Path to the directory where custom AI models are stored |
12+
| `ARDUINO_APP_CLI__ALLOW_ROOT` | `false` | Allow running `arduino-app-cli` as root (**Not recommended to set to true**) |
13+
| `LIBRARIES_API_URL` | `https://api2.arduino.cc/libraries/v1/libraries` | URL of the external service used to search Arduino libraries |
14+
| `DOCKER_REGISTRY_BASE` | `ghcr.io/arduino/` | Docker registry used to pull docker images |
15+
| `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 Arduino Apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder.
18+
19+
Examples of user-defined Arduino Apps stored into the `ARDUINO_APP_CLI__APPS_DIR` folder.
20+
1921
```
2022
├── my-first-app
2123
│   ├── app.yaml

0 commit comments

Comments
 (0)