Skip to content

Commit

Permalink
Restructuring the "Welcome" page for docs (#100)
Browse files Browse the repository at this point in the history
As we start using this page as our landing page for more of CTA's from the site and marketing, I wanted to make a bit more readable and inviting. The goal is to get people into tutorials and building ASAP.

Co-authored-by: Timmy Willison <4timmywil@gmail.com>
Co-authored-by: Josh Ziegler <josh@pylon.com>
  • Loading branch information
3 people authored Sep 16, 2020
1 parent f2f7ec7 commit 8716521
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 9 deletions.
12 changes: 12 additions & 0 deletions content/docs/Concepts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Spokestack Concepts
navId: Concepts Overview
description: In-depth explanations of Spokestack technology
draft: false
---

A smooth voice experience requires several different pieces of technology working together. The three primary systems involved are [ASR](asr), which converts user speech into text; [Natural Language Understanding](nlu), which translates phrases and sentences into actionable input for an application; and [Text to Speech](tts), which converts textual system responses into audio to be read to the user.

These pages exist to introduce, in a platform-indepedent way, how Spokestack uses these technologies and lets you configure them. They also cover general topics like [converting an NLU model](export) from other voice assistant platforms into Spokestack's format and even how to [design custom wakeword models](wakeword-models) for use with Spokestack.

If you're looking for code samples, please see the section dedicated to your mobile platform of choice.
1 change: 1 addition & 0 deletions content/docs/nav.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[
"Welcome",
"Concepts Overview",
"ASR (Concepts)",
"Wakeword Models (Concepts)",
"NLU (Concepts)",
Expand Down
55 changes: 46 additions & 9 deletions content/docs/welcome.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,60 @@
---
title: Welcome
title: Getting Started with Spokestack
navId: Welcome
description: Spokestack documentation for mobile and web voice interface development
draft: false
---

**Experienced voice _and_ mobile developer? Start here...**
Spokestack is a powerful platform of open source libraries and robust services to make your app fully voice-enabled.

If you're looking to integrate Spokestack in your project as fast as possible, our quickstart guides for each platform can be found here:
If you're new to voice, check out our [overview video](https://www.youtube.com/watch?v=wbJ8fZh-iQw) and the [Concepts](/docs/Concepts) section of our docs.

## Integrations

As a tools and services provider, we try to balance ease of integration with customization for your voice interface needs. Here are the ways you can integrate Spokestack with your mobile app:

1. **Spokestack Tray**: Spokestack Tray is a library that provides a voice interface overlay designed to work in any mobile app. Spokestack Tray is opinionated and follows a specific use pattern, but can be customized to meet your own branding requirements. This path is suitable for mobile developers of all experience levels, but it assumes some experience with the underlying platform (React Native, iOS, or Android). Check out our "Get the Bartender" app on [iOS](https://apps.apple.com/us/app/get-the-bartender/id1530425843) and [Android](https://play.google.com/store/apps/details?id=com.spokestack.bartender) for examples of how Tray might work with an existing app.

1. **Custom Integration**: A custom integration gives the app developer full control over voice integration. This path is more suitable for _intermediate_ and _advanced_ mobile developers as it requires building familiarity with individual Spokestack subsystems. Check out the Spokestack Studio app on [iOS](https://apps.apple.com/us/app/spokestack-studio/id1508393980) or the control room sample app on [Android](https://github.com/spokestack/android-control-room) for examples of all of our services and how they work.

If you're looking to integrate Spokestack in your project without using the tray, our **quickstart** guides for each platform can be found here:

- [iOS](/docs/iOS/getting-started)
- [Android](/docs/Android/getting-started)
- [React Native](/docs/React Native/getting-started)
- [React Native](/docs/React%20Native/getting-started)

Tutorials for integrating Spokestack are also available on our blog:

##### Spokestack Tray Tutorials

<br />

- [React Native](/blog/integrating-spokestack-in-react-native)
- _iOS coming soon_
- _Android coming soon_

##### Custom Integration Tutorials

<br />

- [React Native](/blog/integrating-spokestack-in-react-native)
- [iOs](/blog/porting-a-smart-speaker-voice-app-to-mobile-part-1)
- [Android](/blog/porting-the-alexa-minecraft-skill-to-android-using-spokestack)

Check our blog for all of our [Spokestack Tutorials](/blog/tag/tutorial).

### Design Resources

Want to see how you might customize Spokestack Tray for your app? We have [design documentation](/docs/Design/getting-started) to help you get started designing beautiful voice experiences.

We also have a [Figma template](https://www.figma.com/file/LvU9UXNPElCcJ3XYrFXFif/Spokestack-Tray) to help you visualize Spokestack Tray in your app.

### Getting in Touch

**Would you rather start with a tutorial?**
If you have any questions, please see our [forums](https://forum.spokestack.io/).

- [Swift](/blog/porting-a-smart-speaker-voice-app-to-mobile-part-1)
- [Java](/blog/porting-the-alexa-minecraft-skill-to-android-using-spokestack)
Follow us on [Twitter](https://twitter.com/spokestack) for news about Spokestack and tips and tricks for adding custom voice interfaces to your mobile app.

For more details on Spokestack's technology and configuration options, see the list of topics to the left. If you notice anything missing, [open an issue](https://github.com/spokestack/spokestack-website/issues) or pull request; all our documentation is available [on GitHub](https://github.com/spokestack/spokestack-website/tree/develop/content/docs)!
For more details on Spokestack's technology and configuration options, have a look at the other pages in our documentation. If you notice anything missing, please [open an issue](https://github.com/spokestack/spokestack.io/issues) or pull request; all of our documentation is available [on GitHub](https://github.com/spokestack/spokestack.io/tree/develop/content/docs)!

If you have any other questions, please check our [forum](https://forum.spokestack.io/), which we monitor closely. You might find an answer there already.
Welcome to the Spokestack community!

0 comments on commit 8716521

Please sign in to comment.