Welcome to the official docs for Multisynq - the platform for building real-time collaborative applications.
Get started building collaborative applications in minutes:
- Get API Key: Visit multisynq.io/coder for your free API key
- Choose Framework: JavaScript/HTML or React
- Follow Guide: Check our Quickstart Guide
- Getting Started - Introduction to Multisynq
- Quickstart - Build your first app in 5 minutes
- Development Guide - Local development setup
Interactive tutorials with live examples:
- Hello World - Synchronized counter app
- Simple Animation - Real-time animations
- Multi-user Chat - Live chat application
- View Smoothing - Smooth interpolation
- 3D Animation - Three.js integration
- Multiblaster Game - Complete multiplayer game
- Model-View-Synchronizer - Core architecture
- Events & Pub/Sub - Event system
- Snapshots - State persistence
- Persistence - Data storage
- Simulation Time - Time management
- Writing Models - Model patterns
- Writing Views - View patterns
- Writing Apps - Application structure
- Random Numbers - Deterministic randomness
- Data API - Large data handling
- Synchronization - How real-time sync works
- Collaboration - Multi-user patterns
- Chat Systems - Real-time messaging
- Whiteboard Apps - Collaborative drawing
- Conflict Resolution - Handling conflicts
- Scaling - Performance optimization
- Vibe Coding - Train AI assistants with Multisynq
Complete documentation for React-specific development:
- Getting Started - React setup
- Core Hooks - useStateTogether, useFunctionTogether
- Communication - useChat, useCursors
- Components - Pre-built React components
- Utilities - Helper functions
- Session API - Session management
- Model API - Model lifecycle and methods
- View API - View patterns and rendering
# Install Mintlify CLI
npm install -g mintlify
# Start dev server
mintlify dev
# Preview at http://localhost:3000docs/
├── index.mdx # Homepage
├── quickstart.mdx # Quick start guide
├── docs.json # Navigation config
├── essentials/ # Core concepts
├── tutorials/ # Interactive tutorials
├── react-together/ # React-specific docs
├── api-reference/ # API documentation
├── images/ # Static assets
└── logo/ # Brand assets
Use Mintlify's built-in components:
Description of the feature ```bash npm npm install react-together ``` Content for JS tab Content for React tab Important warning message Helpful note or tip- Always include working, complete examples
- Use CDN imports for standalone examples
- Include API key placeholders:
"your-api-key-here" - Test all code examples before publishing
Update docs.json to add new pages:
{
"group": "New Section",
"pages": [
"path/to/new-page"
]
}- Accuracy: All code examples must work with current Multisynq APIs
- Completeness: Include all necessary imports and setup
- Clarity: Explain concepts clearly with examples
- Consistency: Follow established patterns and terminology
- Use realistic app IDs:
"com.example.myapp" - Include error handling where appropriate
- Show both minimal and complete examples
- Test all examples in isolation
- Document all parameters and return values
- Include practical usage examples
- Note version compatibility
- Cross-reference related methods
- Fork the repository
- Create a feature branch
- Make your changes
- Test locally with
mintlify dev - Submit a pull request
All content changes should be reviewed for:
- Technical accuracy
- Code example functionality
- Clarity and readability
- Consistency with existing docs
- Community: Discord
- GitHub: multisynq
- Website: multisynq.io
- API Keys: multisynq.io/coder
This documentation is part of the Multisynq platform. See individual repositories for license information.
Built with ❤️ using Mintlify