Improve Alexa Smart Home Documentation. #11851
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
frenck
requested changes
Jan 27, 2020
There was a problem hiding this comment.
I've stopped reviewing halfway, because it is a huge PR and contains a lot of the same things.
Please:
- Ensure you have an empty line after each heading.
- Use common markdown, avoid the use of HTML. (The images are allowed).
- 1 empty line for separation is enough, more don't have a function in Markdown.
- Lines do not need whitespace at the end.
- Ensure headings are in level order.
- Try to avoid
easy,simple,simpler,easiest,simply, they can be received condescending by the reader.
| @@ -33,11 +31,28 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na | |||
|
|
|||
| </div> | |||
|
|
|||
| ## Amazon Alexa Smart Home | |||
|
|
|||
| ##### Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant | |||
There was a problem hiding this comment.
Header level if of, compared to the parent heading level.
Make a new line after adding a header.
There was a problem hiding this comment.
This is the only one I was unsure of exactly what you were asking. I assume you were saying "header level is off". I ended up removing this header since it's the same as the H1 for the page and restructured the headers for the entire page. Please Confirm.
Co-Authored-By: Franck Nijhof <frenck@frenck.nl>
ochlocracy
commented
Jan 27, 2020
Utterance formatting updates.
frenck
requested changes
Jan 28, 2020
Add utterance. Grammar fixes.
Co-Authored-By: Franck Nijhof <frenck@frenck.nl>
|
Thanks for the help @frenck you are a machine 🤖. |
frenck
approved these changes
Jan 29, 2020
|
Thanks for the PR @ochlocracy! 👍 |
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.
Proposed change
added styling for thekbdandsampHTML tags for voice input.Utterance styling
The currentcodetag does not provide a styling that resonates with voice input/output. Usingkbdandsampis semantically correct for this situation but the default browser style lacks the representation of voice. I reviewed how Google Assistant, and Amazon styled voice input in their documentation and created a style for situations semantically correct for voice input. e.g.ptags insidekbdtags. I welcome comments, as it's something that can be used through the HA documentation.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.