Improve documentation #4
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 snippet 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
…artifact to readme Adding the example workflow to generate the workflow artifact to the arduino/report-size-deltas readme allows the arduino/compile-sketches readme to only demonstrate the basic use of the action without confusing the issue by showing the creation of a workflow artifact that will only be of use to arduino/report-size-deltas users.
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.