fix(doc): add missing prerequisites to dev docs #2531
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document prerequisites of the Arduino CLI, LS, etc. tools when built from a Git commitish. closes: arduino#2499 Signed-off-by: dankeboy36 <[email protected]>
|
I have noticed that https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#prerequisites redirects to https://arduino.github.io/arduino-cli/0.35/CONTRIBUTING/#prerequisites instead of https://arduino.github.io/arduino-cli/1.0/CONTRIBUTING/#prerequisites. Probably it should be https://arduino.github.io/arduino-cli/1.0.4/CONTRIBUTING/#prerequisites (which is a 404) |
per1234
requested changes
Oct 13, 2024
per1234
added
topic: documentation
Co-authored-by: per1234 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
When the IDE depends on a non-released version of the Arduino CLI, LS, etc., tools, it must check out the corresponding pinned commit from Git and build them from the sources. This process requires Go, but it's preferable to use taskfile for the correct timestamps and dev versions. This pull request refers to the existing documentation of the Arduino CLI, and it should be sufficient to build all other binaries.
Change description
Document prerequisites of the Arduino CLI, LS, etc. tools when built from a Git commitish.
Other information
The preview version of the change: https://github.com/arduino/arduino-ide/blob/fda5a5f7714aea8fb4c447fa650e839a1473553d/docs/development.md#prerequisites.
closes: #2499
Reviewer checklist