ToSend Documentation

Official documentation for ToSend - a modern transactional email sending service.

Live Documentation: docs.tosend.com

Overview

This repository contains the complete documentation for ToSend, including:

• User Guides - Domain setup, API keys, webhooks, suppressions, and billing
• API Reference - Complete REST API documentation with examples
• SDKs - Official SDKs for Node.js, Python, Go, Laravel, and PHP
• WordPress Integration - Guide for using ToSend with WordPress

Tech Stack

• VitePress - Vue-powered static site generator
• Cloudflare Pages - Deployment platform
• pnpm - Fast, disk space efficient package manager

Getting Started

Prerequisites

• Node.js 18 or higher
• pnpm 8.0 or higher

Installation

# Clone the repository
git clone https://github.com/tosend/docs-site.git
cd docs-site

# Install dependencies
pnpm install

Local Development

Start the development server with hot module replacement:

pnpm dev

The documentation site will be available at http://localhost:5173

Build

Generate the static site:

pnpm build

The built files will be in .vitepress/dist

Preview

Preview the production build locally:

pnpm preview

Project Structure

docs-site/
├── .vitepress/
│   ├── config.mjs         # VitePress configuration
│   └── dist/              # Build output (ignored)
├── docs/
│   ├── index.md           # Homepage
│   ├── guide/             # User guides
│   ├── api/               # API reference
│   └── sdks/              # SDK documentation
├── package.json
└── README.md

Deployment

This site automatically deploys to docs.tosend.com via Cloudflare Pages when you push to the master branch.

To deploy:

git add .
git commit -m "Update documentation"
git push origin master

Cloudflare Pages will automatically build and deploy your changes in ~1 minute.

Preview deployments:

• Pull requests automatically get preview URLs
• Feature branches get their own preview deployments

Contributing

We welcome contributions to improve the documentation!

How to Contribute

1. Fork the repository
2. Create a feature branch (git checkout -b improve-api-docs)
3. Make your changes
4. Test locally with pnpm dev
5. Commit your changes (git commit -m 'Improve API documentation')
6. Push to your branch (git push origin improve-api-docs)
7. Open a Pull Request

Writing Guidelines

• Use clear, concise language
• Include code examples where applicable
• Follow the existing markdown formatting
• Test all code snippets before submitting
• Add screenshots for UI-related guides

Adding New Pages

1. Create a new .md file in the appropriate directory (docs/guide/, docs/api/, or docs/sdks/)
2. Add the page to the sidebar in .vitepress/config.mjs
3. Test the navigation locally

Documentation Sections

User Guide

Complete guides for using ToSend:

• Domain verification and DNS setup
• DMARC configuration
• API key management
• Webhook integration
• Email logs and analytics
• Suppression list management
• Billing and usage metrics
• WordPress integration

API Reference

RESTful API documentation:

• Authentication
• Send single emails
• Send batch emails
• Retrieve account information
• Error handling

SDKs

Official SDKs and integration guides:

• Node.js
• Python
• Go
• Laravel
• PHP

Links

• Main Site: tosend.com
• Documentation: docs.tosend.com
• GitHub: github.com/tosend
• Support: support@tosend.com

License

MIT License - Copyright © ToSend

---

Built with ❤️ by the ToSend team