Comprehensive and user-friendly documentation for the SAMA Server API.
This repository serves as the home for the official SAMA API documentation, implemented with Astro & Starlight. It provides detailed guidance on using the SAMA Server via WebSocket (WSS) and HTTP endpoints, including real-world examples, parameter definitions, and best practices.
Explore the documentation to learn about:
- Overview and Quick Start guidelines
- Deployment methods for server and clients
- Full details of API methods (WSS & HTTP)
- Features such as encryption, clustering, and scalability
To preview locally:
npm install
npm run dev
Then open your browser at http://localhost:4321/ (or the port specified in your configuration).
To build the production version:
npm run build
npm run preview
This repository is distributed under the Apache-2.0 License — see LICENSE for details.