Replace firmware restoration instructions with link to duplicate Help Center content #51
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
… Center content Unfortunately, the firmware packaging system includes the version number in the firmware binary filename. The exact binary filename is referenced in the firmware restoration instructions, which means that they must be updated on every release or else become obsolete. Equivalent instructions have also been published in the Arduino Help Center. The fact that the maintainers of both projects have failed to keep their instructions updated through the course of multiple releases and over 6 months shows that is is not feasible to maintain redundant copies of the instructions. Since these instructions are not directly relevant to the updater scripts, they are not really in scope for the script's readme. The Help Center article is significantly discoverable to the user, slightly higher quality that the variant here, and it makes more sense to put the responsibility for such content on the maintainers of the Help Center. For these reasons, the redundant instructions are removed from this repository, replaced with a link to the Help Center article.
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.
Unfortunately, the firmware packaging system includes the version number in the firmware binary filename. The exact binary filename is referenced in the firmware restoration instructions, which means that they must be updated on every release or else become obsolete.
Equivalent instructions have also been published in the Arduino Help Center. The fact that the maintainers of both projects have failed to keep their instructions updated through the course of multiple releases and over 6 months shows that is is not feasible to maintain redundant copies of the instructions.
Since these instructions are not directly relevant to the updater scripts, they are not really in scope for the script's readme. The Help Center article is significantly discoverable to the user, slightly higher quality that the variant here, and it makes more sense to put the responsibility for such content on the maintainers of the Help Center. For these reasons, the redundant instructions are removed from this repository, replaced with a link to the Help Center article.
I have also submitted an update for the currently obsolete Help Center article: arduino/help-center-content#349
Originally reported at:
https://forum.arduino.cc/t/arduino-uno-r4-wifi-recognized-as-esp32-devices/1177896