Add documentation on the new plugin system #178
Merged
Conversation
This file contains 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
MatteoPologruto
added
type: enhancement
alessio-perugini
approved these changes
Jul 19, 2023
per1234
requested changes
Jul 19, 2023
There was a problem hiding this comment.
Please add plugins.md to the nav key of the mkdocs.yml configuration file:
https://github.com/arduino/arduino-fwuploader/blob/main/mkdocs.yml
This will cause the page to be listed in the navigation panel of the website.
Reference:
https://www.mkdocs.org/user-guide/configuration/#nav
| [interface](https://github.com/arduino/fwuploader-plugin-helper/blob/main/plugin.go#L28) contained in the | ||
| [fwuploader-plugin-helper](https://github.com/arduino/fwuploader-plugin-helper) repository. | ||
|
|
||
| The fwuploader is still responsible for downloading the files required for the plugin to work: |
There was a problem hiding this comment.
Suggested change
| The fwuploader is still responsible for downloading the files required for the plugin to work: | |
| Arduino Firmware Uploader is still responsible for downloading the files required for the plugin to work: |
|
@per1234 since @MatteoPologruto is OOO and he created a fork I'm merging this into a new branch so I can apply your suggestions in a new commit 🙏 |
alessio-perugini
merged commit ac044a9
into
arduino:add-new-plugin-docs
6 checks passed
alessio-perugini
added a commit
that referenced
this pull request
Jul 20, 2023
* Add documentation on the new plugin system (#178) * Apply Code Review suggestions --------- Co-authored-by: MatteoPologruto <109663225+MatteoPologruto@users.noreply.github.com>
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.
The documentation on the new plugin system has been added.