Improve documentation #6
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
Collaborator
per1234
commented
Sep 11, 2020
per1234
commented
- Add badges to readme to indicate CI status
- Correct branch name shown in example snippets in readme
- Format the documentation to make default input values easy to find
- Improve formatting of readme
- Linkify readme text where appropriate to provide easy access to supporting information
Unlike the original repository, this repository uses a default branch named `main` instead of `master`.
Previously, the information on whether an input had a default value -- and if so, what -- was incorporated into the input description. This meant you had to read the entire description to find this information. When using other actions, I have regularly had difficulty determining which inputs are required and default input values. I would like for the users of this action to not have that experience.
…rting information
per1234
added
type: imperfection
Even though the generic form was already provided, people who only use the IDEs will not necessarily be familiar with this notation.
Now that arduino/compile-sketches always generates a sketches report, the conditional in the workflow snippet in the readme is unnecessary. Although a user may decide they want to do advanced configuration of their workflow to control when the artifact is generated, there is no requirement that it only be made on pull_request events, so this only adds unnecessary complexity to the example. The example should contain only the minimum necessary to effectively demonstrate the basic use of the action.
Break up some "walls of text".
Although the user should be able to just set the input to `true` and get deltas, it may sometimes be useful to understand exactly how this data is produced in order to fully understand its meaning.
Library authors may define dependencies of the library in the `depends` field of its library.properties metadata file. These dependencies are automatically installed for libraries sourced from Library Manager.
Generated using https://github.com/jonschlinkert/markdown-toc ``` npm install --global markdown-toc markdown-toc --bullets=- --maxdepth=5 -i ./README.md ```
The likely use for a sketches report workflow artifact is for the `arduino/report-size-deltas` action. Especially now that they are hosted in separate repositories, it makes more sense to provide this example in the documentation of that action alongside the `arduino/report-size-deltas` example that inherently depends on it.
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.