Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for building SSML responses #276

Merged
merged 3 commits into from
Sep 1, 2017
Merged

Added documentation for building SSML responses #276

merged 3 commits into from
Sep 1, 2017

Conversation

tejashah88
Copy link
Member

@tejashah88 tejashah88 commented Aug 18, 2017

Resolves #246 and #74.

README.md Outdated
@@ -247,6 +248,49 @@ async response.fail(String message)
return response.say("OK").send()
```

#### Building SSML Responses

The [ssml-builder](https://github.com/mandnyc/ssml-builder) library is a great tool for building SSML responses. While it's meant to be a general purpose SSML builder, it does supports [Amazon-specific SSML tags](https://github.com/mandnyc/ssml-builder#amazon-ssml-specific-tags). See the [official Amazon documentation](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference) for which SSML tags you can use.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it "does support" (remove s) or "supports"

README.md Outdated
The [ssml-builder](https://github.com/mandnyc/ssml-builder) library is a great tool for building SSML responses. While it's meant to be a general purpose SSML builder, it does supports [Amazon-specific SSML tags](https://github.com/mandnyc/ssml-builder#amazon-ssml-specific-tags). See the [official Amazon documentation](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference) for which SSML tags you can use.

Example using basic SSML tags:
```javascript
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add an empty line? Let it breathe :)

README.md Outdated
@@ -247,6 +248,49 @@ async response.fail(String message)
return response.say("OK").send()
```

#### Building SSML Responses

The [ssml-builder](https://github.com/mandnyc/ssml-builder) library is a great tool for building SSML responses. While it's meant to be a general purpose SSML builder, it does supports [Amazon-specific SSML tags](https://github.com/mandnyc/ssml-builder#amazon-ssml-specific-tags). See the [official Amazon documentation](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/speech-synthesis-markup-language-ssml-reference) for which SSML tags you can use.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a nitpick, but we could be more "directed" with just "Use ssml-builder to build SSML responses." Shorter and to the point.

@dblock
Copy link
Collaborator

dblock commented Aug 19, 2017

Needs some grammar fixes and a rebase, otherwise feel free to merge.

@lazerwalker lazerwalker mentioned this pull request Aug 19, 2017
3 tasks
@tejashah88 tejashah88 merged commit 87fa798 into alexa-js:master Sep 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants