Getting ready for docs update #24
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the project to use Arduino CLI for firmware installation, links to the new documentation site, and adds a development container setup.
- Swap out in-repo Getting Started instructions for a link to the hosted docs site.
- Introduce Makefile targets to download CircuitPython and detect TTY ports via Arduino CLI.
- Add a
.devcontainerconfiguration for a Python 3.13 development container with relevant extensions.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Simplified intro to point to new docs site and rebranded as a template repository |
| Makefile | Added install-circuit-python, list-tty, Arduino CLI download, CircuitPython download, and version defaults |
| .devcontainer/devcontainer.json | New devcontainer setup using Python 3.13 with container environment variables and recommended extensions |
Comments suppressed due to low confidence (1)
README.md:1
- [nitpick] Ensure consistent branding across the docs—choose either “PROVES Kit” or “ProvesKit” and apply it uniformly.
# PROVES Kit RP2040 v4 CircuitPython Flight Software and Ground Station
| @@ -1,5 +1,8 @@ | |||
| PYSQUARED_VERSION ?= v2.0.0-alpha-25w26-2 | |||
| PYSQUARED ?= git+https://github.com/proveskit/pysquared@$(PYSQUARED_VERSION) | |||
| BOARD_MOUNT_POINT ?= "" | |||
There was a problem hiding this comment.
Remove the surrounding quotes on empty defaults so the variable value is truly empty; e.g., BOARD_MOUNT_POINT ?= instead of ?= "".
| BOARD_MOUNT_POINT ?= "" | |
| BOARD_MOUNT_POINT ?= |
Copilot uses AI. Check for mistakes.
| @$(ARDUINO_CLI) config init || true | ||
| @$(ARDUINO_CLI) config add board_manager.additional_urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json | ||
| @$(ARDUINO_CLI) core install rp2040:[email protected] | ||
| @$(ARDUINO_CLI) upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p $(BOARD_TTY_PORT) -i $(CIRCUIT_PYTHON) |
There was a problem hiding this comment.
The -b 115200 flag is interpreted as --fqbn by Arduino CLI, conflicting with the subsequent --fqbn. Replace or remove -b 115200 and use the correct CLI option for baud rate (if supported) or omit it if not needed.
| @$(ARDUINO_CLI) upload -v -b 115200 --fqbn rp2040:rp2040:rpipico -p $(BOARD_TTY_PORT) -i $(CIRCUIT_PYTHON) | |
| @$(ARDUINO_CLI) upload -v --fqbn rp2040:rp2040:rpipico -p $(BOARD_TTY_PORT) -i $(CIRCUIT_PYTHON) |
Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <[email protected]>
Summary
I'm rewriting the getting started docs and wanted to try avoid telling people to push specific buttons on the board. This change uses Arduino CLI to force the board into boot loader mode and install firmware. It also provides a consistent (🤞) way to find the TTY ports for our boards. This PR also links the readme to our new docs site and adds a dev container description.
How was this tested