Adding detailed text to QuickStart & Functionality Guide, adding Troubleshooting page. #2
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
…ell as the addition of a troubleshooting guide.
…or battery replacement.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
There are a few points about using Blinks I thought may be helpful for developers jumping in for the first time - namely, being aware of some of the pre-defined capabilities Blinks have. I added the following to the docs:
QuckStart Page: Added an explanation of how to share code with other blinks.
Functionality Page: Added explanations about pre-defined functions, including sleep/wake, code sharing, and error codes.
Added a Troubleshooting page to list error codes. This could also be used for commonly seen issues from the forums or other sources (to save people from having to search around for them).
I thought adding an image to the troubleshooting page of a blink with all red L.E.D.'s might be a nice touch, but I didn't really want to attempt it without the original graphic assets. Feel free to correct me on any of my info in these edits!