Skip to content

Commit 4b5e754

Browse files
committed
docs: update development guide and issue report instructions for clarity
1 parent 901f8de commit 4b5e754

File tree

3 files changed

+25
-14
lines changed

3 files changed

+25
-14
lines changed

Taskfile.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,17 @@ tasks:
123123
echo "Examples successfully cloned."
124124
silent: false
125125

126-
arduino-app-cli:build:local:
126+
build:
127127
desc: "Build the arduino-app-cli locally"
128128
cmds:
129129
- go build -v -o ./build/arduino-app-cli ./cmd/arduino-app-cli
130130

131+
start:
132+
desc: "build and launch the arduino-app-cli in daemon mode"
133+
cmds:
134+
- task build
135+
- ./build/arduino-app-cli daemon --port 8800
136+
131137
arduino-app-cli:release:
132138
desc: Create a tag on the current commit and push it to the remote to create the release
133139
cmds:
@@ -139,11 +145,7 @@ tasks:
139145
- git tag -a "{{.CLI_ARGS}}" -m "Release {{.CLI_ARGS}}"
140146
- git push origin "{{.CLI_ARGS}}"
141147

142-
arduino-app-cli:start:
143-
desc: "build and launch the arduino-app-cli in daemon mode"
144-
cmds:
145-
- task arduino-app-cli:build:local
146-
- ./build/arduino-app-cli daemon --port 6060
148+
147149

148150
# To to forward a port, using ssh, you can use this command:
149151
# ssh -L 8800:localhost:8800 arduino@<BOARD_IP>

docs/contributor-guide/development.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
# Development Guide
44

5+
> [!NOTE]
6+
> The `arduino-app-cli` is designed to run on the Board and access peripherals that are not available on a development PC (e.g., the microcontroller).
7+
>
8+
> For easier testing, using an **Arduino UNO Q** is recommended, as local testing is limited to functionalities that do not require board-specific features.
9+
510
## Prerequisites
611

712
The following development tools must be available in your local environment:
@@ -13,6 +18,9 @@ The following development tools must be available in your local environment:
1318
## Building the Project
1419

1520
- `task init`
21+
- `task build`
22+
- `task generate:assets` to download locally the assets of the [Arduino Bricks](`https://github.com/arduino/app-bricks-py`)
23+
- `ARDUINO_APP_CLI__DATA_DIR=debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli task start` to build and start the arduino-app-cli in daemon mode.
1624

1725
## Running Checks
1826

@@ -21,11 +29,10 @@ Checks and tests are set up to ensure the project content is functional and comp
2129
- `task fmt-check`
2230
- `task test`
2331

24-
## Testing arduino-app-cli into the board
25-
Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
26-
27-
- `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.
28-
32+
## Installing arduino-app-cli into the board
33+
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.
2936

3037
## Automatic Corrections
3138

@@ -36,4 +43,6 @@ Tools are provided to automatically bring the project into compliance with some
3643

3744

3845
## Generate API docs
39-
If th
46+
If a PR, change the HTTP API definitions, the following steps are needed:
47+
1. Open the `cmd/gendoc/docs.go` and modify/add/remove the definitions
48+
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/contributor-guide/issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ https://github.com/arduino/arduino-app-cli/issues/new/choose
1414

1515
## Before Reporting an Issue
1616

17-
- Give the latest development version a test drive to see if your issue was already resolved:<br />
18-
<!-- TODO: Nightly build link -->
17+
- Give the latest development version t (pre-releases) a test drive to see if your issue was already resolved:<br />
18+
https://github.com/arduino/arduino-app-cli/releases?q=prerelease%3Atrue
1919
- Search [existing pull requests and issues](https://github.com/arduino/arduino-app-cli/issues?q=) to see if it was already reported.<br />
2020
If you have additional information to provide about an existing issue, please comment there instead of creating a duplicate. You can use [GitHub's "Reactions" feature](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) if you only want to express support 👍.
2121

0 commit comments

Comments
 (0)