Skip to content

Commit

Permalink
docs: add readme and doc folder
Browse files Browse the repository at this point in the history
  • Loading branch information
Shen Chen committed Jul 22, 2020
1 parent d48afda commit 056070e
Show file tree
Hide file tree
Showing 5 changed files with 2,490 additions and 0 deletions.
38 changes: 38 additions & 0 deletions ask-sdk-controls/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!-- markdownlint-disable MD041 -->
<!-- markdownlint-disable MD033 -->

<p align="center">
<img src="https://m.media-amazon.com/images/G/01/mobile-apps/dex/avs/docs/ux/branding/mark1._TTH_.png">
<br/>
<h1 align="center">ASK SDK Controls Framework (Beta)</h1>
</p>

The ASK SDK Controls framework builds on the [ASK SDK for Node.js](https://github.com/alexa/alexa-skills-kit-sdk-for-nodejs), offering a scalable solution for creating large, multi-turn skills in code with reusable components called *controls*.

## Documentation

- [About the Controls Framework](https://alexa.design/controls)
- [User Guide](https://github.com/alexa/alexa-skills-kit-sdk-for-nodejs/tree/2.0.x/ask-sdk-controls/doc/userGuide.md)
- [API Reference](http://ask-sdk-controls-typedoc.s3-website-us-east-1.amazonaws.com)

## Samples

### [Hello World](https://github.com/alexa/skill-sample-controls-hello-world)

Sample that familiarizes you with the Controls framework, allowing you to hear a response from Alexa when you trigger the skill.

### [Fruit Shop](https://github.com/alexa/skill-sample-controls-fruit-shop)

Build a multi-modal grocery shopping skill using custom and library controls for item lists, shopping cart management, and checkout.

## Opening Issues

For bug reports, feature requests and questions, we would like to hear about it. Search the [existing issues](https://github.com/alexa/alexa-skills-kit-sdk-for-nodejs/issues) and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of the SDK, Node.js or browser environment and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.

## License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

## Got Feedback?

Request and vote for Alexa features [here](https://alexa.uservoice.com/forums/906892-alexa-skills-developer-voice-and-vote/filters/top?category_id=322783)!
Binary file added ask-sdk-controls/doc/img/fruitShopControlTree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ask-sdk-controls/doc/img/handlingChain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ask-sdk-controls/doc/img/requestHandling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 056070e

Please sign in to comment.