Sidecar frontend readme docs #283
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
joelhawksley
reviewed
Apr 1, 2020
|
Also, can you add yourself to the README? |
|
@joelhawksley I appreciate the detailed response! I'll review your suggestions and provide an update by tomorrow. |
Flesh out Web Component description Update README.md Co-Authored-By: Joel Hawksley <joelhawksley@github.com> Incorporate Joel's README suggestions
jaredcwhite
force-pushed
the
sidecar-frontend-readme-docs
branch
from
bf38dd0 to
6950209
Compare
|
@joelhawksley Hey, so I incorporated your copy recommendations, fixed a few bugs in the example code, and added myself to the bottom of the README. Let me know what you think! |
|
Thank you for your contribution @jaredcwhite! |
rmacklin
reviewed
Apr 3, 2020
| |:---:|:---:|:---:|:---:| | ||
| |@blakewilliams|@seanpdoyle|@tclem|@nashby| | ||
| |Boston, MA|New York, NY|San Francisco, CA|Minsk| | ||
| |<img src="https://avatars.githubusercontent.com/blakewilliams?s=256" alt="blakewilliams" width="128" />|<img src="https://avatars.githubusercontent.com/seanpdoyle?s=256" alt="seanpdoyle" width="128" />|<img src="https://avatars.githubusercontent.com/tclem?s=256" alt="tclem" width="128" />|<img src="https://avatars.githubusercontent.com/nashby?s=256" alt="nashby" width="128" />|<img src="https://avatars.githubusercontent.com/jaredcwhite?s=256" alt="nashby" width="128" />| |
There was a problem hiding this comment.
Minor, but I think the alt attribute should be jaredcwhite
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.
Summary
This is a first draft of adding info on sidecar frontend assets to the README (related to #168). I need to test out the examples more to make sure they're bug-free and some of the wording could be streamlined, but I wanted your overall feedback before tweaking it too much.
Other Information
I feel like this might be a good candidate for adding to a separate .md docs file somewhere, as I'm not quite sure it integrates holistically into the existing README flow. Let me know what you think.