Dialect Developer Documentation

This repository contains the developer documentation for Dialect's Blinks and Alert Stack.

Overview

The Dialect Developer Documentation provides guides, tutorials, and API references for developers looking to build and integrate Dialect products into their applications. It covers various topics, including:

• Blinks: Distributable experiences that can be embedded anywhere a link can exist
• Alerts: Real-time notifications and updates for your users
• API Documentation: Detailed references for Dialect's HTTP endpoints

Getting Started

To access the Dialect Developer Documentation, simply visit docs.dialect.to. This is the recommended way to view and use the documentation.

If you want to contribute to the documentation, you can follow these steps to set up a local development environment:

1. Clone the repository:

   git clone https://github.com/dialectlabs/docs.git

2. Install the dependencies:

   cd docs
   yarn install

3. Start the development server:

   yarn start

   This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

For more information on contributing to the Dialect Developer Documentation, please refer to our Contribution Guidelines.

Documentation Structure

The documentation is organized into the following main sections:

• Blinks: Guides and tutorials for integrating Blinks into your applications using the Blinks Client SDK or headless integration options.
• Alerts: Documentation for setting up and managing real-time notifications using Dialect Alerts.
• API: API references for Dialect's HTTP endpoints, allowing developers to interact with Dialect products programmatically.

Contributing

We welcome contributions to improve the Dialect Developer Documentation. If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

Before contributing, please review our Contribution Guidelines for more information on how to contribute to this project.

License

The Dialect Developer Documentation is open-source and released under the MIT License.

Contact

If you have any questions or need assistance, please reach out to us:

• Discord: Dialect Discord Server
• Twitter: @saydialect
• Email: [email protected]

We look forward to seeing what you build with Dialect!