Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions website/config/sidebarsConfig/main/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,19 @@

import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
import homeSidebar from "./home-sidebar";
import sdksSidebar from "./sdks-sidebar";
import restApiSidebars from "./rest-api-sidebar";
import swmlTechRefSidebar from "./swml-sidebar";
import compatibilityAPI from "./compatibility-api-sidebar";
import cantinaSidebar from "./cantina-sidebar";
import callFlowBuilderSidebar from "./call-flow-builder-sidebar";

const mainSidebars: SidebarsConfig = {
...homeSidebar,
...sdksSidebar,
...restApiSidebars,
...swmlTechRefSidebar,
...compatibilityAPI,
...cantinaSidebar,
...callFlowBuilderSidebar,
};
...homeSidebar,
...restApiSidebars,
...swmlTechRefSidebar,
...compatibilityAPI,
...cantinaSidebar,
...callFlowBuilderSidebar,
};

export default mainSidebars;
export default mainSidebars;
50 changes: 0 additions & 50 deletions website/config/sidebarsConfig/main/sdks-sidebar.ts

This file was deleted.

2 changes: 1 addition & 1 deletion website/docs/main/home/calling/voice/voice-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Please reach out to [Support@signalwire.com](mailto:Support@signalwire.com) to g
</Accordion>

<Accordion title="Can you build an IVR (Interactive Voice Response) with SignalWire?">
Yes, SignalWire has all the components to build a very powerful IVR! You could use the [Compatibility API](/compatibility-api), [Relay SDK](sdks/01-overview/00-sdks-technical-reference.mdx), or even build a video/voice solution using our [Javascript SDKs](/sdks/browser-sdk).
Yes, SignalWire has all the components to build a very powerful IVR! You could use the [Compatibility API](/compatibility-api), [Relay SDK](/sdks), or even build a video/voice solution using our [Javascript SDKs](/sdks/browser-sdk).
Check out some working IVR demos built with SignalWire such as
[Dynamic IVR using JSON Menus](/compatibility-api/guides/voice/python/dynamic-ivr-using-json-menus),
[IVR with Voicemails Forwarded to Email](/compatibility-api/guides/voice/nodejs/ivr-with-voicemail-to-email), and
Expand Down
2 changes: 1 addition & 1 deletion website/docs/main/home/overview/homepage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import Sigmond from "@site/src/components/Sigmond"
- Take advantage of building sophisticated AI agents with the new [AI Agents SDK](/sdks/agents-sdk)
- [Voice APIs](/voice) that outperform the competition
- Integrated ultra low-latency [Voice AI](/swml/methods/ai) for human-like interaction – intuitive routing and logic with [SWML](/swml) and API access with [SWAIG](/swml/guides/ai/swaig) serverless functions
- Build with [compatible REST APIs](/compatibility-api) or next-generation [WebSocket realtime APIs](/sdks/overview/what-is-relay)
- Build with [compatible REST APIs](/compatibility-api) or next-generation [WebSocket realtime APIs](/sdks/#what-is-relay)
- Robust [Chat](/chat/), [Fax](fax/), and [Video](video/) APIs and SDKs
- High-throughput [Messaging](messaging/) backed by unmatched support to stay compliant and maximize delivery rates

Expand Down
2 changes: 1 addition & 1 deletion website/docs/main/home/platform/call-fabric/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ For example, all of the following are Resources:
- [Subscribers](#subscribers)
- [SWML Scripts](/swml)
- [Compatibility XML Webhooks/Applications](/compatibility-api/cxml)
- [Relay apps](/sdks/overview/what-is-relay)
- [Relay apps](/sdks/#what-is-relay)
- [SignalWire AI Agents](/swml/methods/ai)
- Video Conferences:
- [Programmable API Video Conferences](/video/getting-started/managing-rooms-with-apis)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ A Relay Application Resource will have the following details:
## Learn more

For more information on Relay, please refer to the
[Relay documentation](/sdks/overview/what-is-relay).
[Relay documentation](/sdks/#what-is-relay).
Original file line number Diff line number Diff line change
@@ -1,10 +1,58 @@
---
title: Understanding SignalWire SDK Releases
slug: /sdks
sidebar_label: "SDKs Overview"
title: "SDKs Overview"
---

# Understanding Alpha and Beta Releases
import { FaServer } from "react-icons/fa"
import { MdWeb } from "react-icons/md"
import { FaRobot } from "react-icons/fa"
import { LuCodeXml } from "react-icons/lu"

SignalWire offers a range of SDKs to help you build applications using the SignalWire platform.


<CardGroup cols={2}>
<Card
title="Agents SDK"
href="/sdks/agents-sdk"
description="Utilize the SignalWire Agents SDK to build AI-powered applications."
icon={<FaRobot />}
/>
<Card
title="Browser SDK"
href="/sdks/browser-sdk"
description="Utilize the SignalWire Browser SDK to build WebRTC-based applications."
icon={<MdWeb />}
/>

<Card
title="Realtime SDK"
href="/sdks/realtime-sdk"
description="Utilize the SignalWire Realtime SDK to build real-time applications from your backend."
icon={<FaServer />}
/>
<Card
title="Compatibility SDKs"
href="/compatibility-api/sdks"
description="The compatibility SDKs help developers migrate their existing XML based applications to the SignalWire platform."
icon={<LuCodeXml />}
/>
</CardGroup>


## What is RELAY?

RELAY is the next generation of interactive communication APIs available at SignalWire. It is a new, real-time web service protocol that provides for persistent, asynchronous connections to the SignalWire network.

Most providers use [REST APIs](https://en.wikipedia.org/wiki/Representational_state_transfer) that rely on one-way communication. This adds latency and limits interactivity of real-time events. SignalWire's RELAY APIs use WebSocket technology, which allow for simultaneous, bi-directional data transmission. Using RELAY, you can deploy reliable, low latency, real-time communications.

RELAY allows for interactive and advanced command and control. Complete control will enable easy transfers and injections across all endpoints, making it easier and quicker to build applications. RELAY integrates easily with your products and infrastructure, enabling simple but powerful applications using Artificial Intelligence tools, data exchange, serverless technologies and more.

Finally, RELAY enables communications tools to perform in the most popular and widely used environments, like web browsers, mobile devices, in the cloud, or within your own infrastructure.

## What are Alpha and Beta Releases of the SDKs?

## **What are Alpha and Beta Releases?**

As part of our development and release process, we often release software in stages. These stages are referred to as alpha and beta releases. It's important to understand what these terms mean and how they affect you as a user.

Expand All @@ -23,14 +71,14 @@ A beta release is the next stage in our release process. Here's what to expect:
- **Known and Unknown Bugs**: While beta versions are more stable than alpha versions, they still contain bugs. We rely on your feedback to find and fix these issues.
- **Prioritized Support**: Customers using beta releases will receive prioritized support when reporting bugs. Your feedback helps us ensure the final product is as robust as possible.

## **Why Participate in Alpha and Beta Testing?**
#### **Why Participate in Alpha and Beta Testing?**

Participating in alpha and beta testing allows you to:
- **Get Early Access**: Be the first to try out new features and improvements.
- **Shape the Product**: Your feedback directly influences the development and refinement of our software.
- **Improve Stability**: Help us identify and fix bugs before the general release, ensuring a smoother experience for all users.

## How We Handle Bugs
#### How We Handle Bugs

Regardless of whether you're using an alpha or beta release, we are committed to addressing bugs promptly. Here's our process:
1. **Identification**: We track all reported bugs and prioritize them based on severity and impact.
Expand All @@ -39,12 +87,11 @@ Regardless of whether you're using an alpha or beta release, we are committed to



## **How to Provide Feedback**
#### **How to Provide Feedback**

If you encounter a bug or have suggestions for improvement, please report them to our support team. You can reach us via email at [support@signalwire.com](mailto:support@signalwire.com)
or by [submitting a ticket](https://signalwire.zohodesk.com/portal/en/newticket).


Your participation in our alpha and beta testing programs is invaluable. We appreciate your willingness to help us improve and look forward to your feedback.

Thank you for being a part of our development process!
Thank you for being a part of our development process!

This file was deleted.

9 changes: 0 additions & 9 deletions website/docs/main/sdks/01-overview/01-what-is-relay.mdx

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Easily upgrade to the version 4 of the Realtime SDK.

[automated-appointment-reminders]: https://signalwire.com/blogs/developers/build-a-call-appointment-reminder-using-signalwire-relay
[interactive-voice-response]: https://signalwire.com/blogs/industry/what-is-ivr-interactive-voice-response
[this-explainer]: /sdks/overview/what-is-relay
[this-explainer]: /sdks/#what-is-relay

# Upgrading to RELAY v4

Expand Down
2 changes: 1 addition & 1 deletion website/src/components/AlphaBetaBadges/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ function Base({ text, color }) {
}}
>
<Link
to={`/sdks/overview/sdk-releases#${text.toLowerCase()}`}
to={`/sdks/#${text.toLowerCase()}`}
style={{ color: "white" }}
className="badge-link"
>
Expand Down