https://github.com/dialectlabs/docs-mintlify
Dialect Developer Documentation for Blinks and Alerts incl. API endpoints
https://github.com/dialectlabs/docs-mintlify
Last synced: 10 months ago
JSON representation
Dialect Developer Documentation for Blinks and Alerts incl. API endpoints
- Host: GitHub
- URL: https://github.com/dialectlabs/docs-mintlify
- Owner: dialectlabs
- License: mit
- Created: 2025-06-20T11:21:04.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-08-12T15:20:15.000Z (10 months ago)
- Last Synced: 2025-08-12T17:14:33.709Z (10 months ago)
- Language: MDX
- Size: 285 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://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:
```bash
git clone https://github.com/dialectlabs/docs-mintlify.git
```
2. Install the dependencies:
```bash
cd docs
yarn install
```
3. Start the development server:
```bash
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](CONTRIBUTING.md).
## 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](CONTRIBUTING.md) for more information on how to contribute to this project.
## License
The Dialect Developer Documentation is open-source and released under the [MIT License](LICENSE).
## Contact
If you have any questions or need assistance, please reach out to us:
- Discord: [Dialect Discord Server](https://discord.gg/saydialect)
- Twitter: [@saydialect](https://twitter.com/saydialect)
- Email: hello@dialect.to
We look forward to seeing what you build with Dialect!