{"id":29432101,"url":"https://github.com/multisynq/docs","last_synced_at":"2025-07-22T01:34:57.681Z","repository":{"id":303668402,"uuid":"1012789967","full_name":"multisynq/docs","owner":"multisynq","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-19T19:57:39.000Z","size":42890,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-19T20:06:30.409Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/multisynq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-02T22:18:38.000Z","updated_at":"2025-07-19T19:57:42.000Z","dependencies_parsed_at":"2025-07-08T20:34:38.550Z","dependency_job_id":"df7b5945-3f26-4ae7-81ad-ea5f0cd64098","html_url":"https://github.com/multisynq/docs","commit_stats":null,"previous_names":["multisynq/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/multisynq/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multisynq%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multisynq%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multisynq%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multisynq%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/multisynq","download_url":"https://codeload.github.com/multisynq/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multisynq%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266409670,"owners_count":23924287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-12T22:01:07.183Z","updated_at":"2025-07-22T01:34:57.667Z","avatar_url":"https://github.com/multisynq.png","language":"MDX","funding_links":[],"categories":["MDX"],"sub_categories":[],"readme":"# Multisynq Documentation\n\nWelcome to the official docs for Multisynq - the platform for building real-time collaborative applications.\n\n## 🚀 Quick Start\n\nGet started building collaborative applications in minutes:\n\n1. **Get API Key**: Visit [multisynq.io/coder](https://multisynq.io/coder) for your free API key\n2. **Choose Framework**: JavaScript/HTML or React\n3. **Follow Guide**: Check our [Quickstart Guide](./quickstart.mdx)\n\n## 📚 Documentation Structure\n\n### Core Guides\n- **[Getting Started](./index.mdx)** - Introduction to Multisynq\n- **[Quickstart](./quickstart.mdx)** - Build your first app in 5 minutes\n- **[Development Guide](./development.mdx)** - Local development setup\n\n### Tutorials\nInteractive tutorials with live examples:\n\n#### Practical Tutorials\n- **[Hello World](./tutorials/hello-world.mdx)** - Synchronized counter app\n- **[Simple Animation](./tutorials/simple-animation.mdx)** - Real-time animations\n- **[Multi-user Chat](./tutorials/multiuser-chat.mdx)** - Live chat application\n- **[View Smoothing](./tutorials/view-smoothing.mdx)** - Smooth interpolation\n- **[3D Animation](./tutorials/3d-animation.mdx)** - Three.js integration\n- **[Multiblaster Game](./tutorials/multiblaster-game.mdx)** - Complete multiplayer game\n\n#### Conceptual Tutorials\n- **[Model-View-Synchronizer](./tutorials/model-view-synchronizer.mdx)** - Core architecture\n- **[Events \u0026 Pub/Sub](./tutorials/events-pub-sub.mdx)** - Event system\n- **[Snapshots](./tutorials/snapshots.mdx)** - State persistence\n- **[Persistence](./tutorials/persistence.mdx)** - Data storage\n- **[Simulation Time](./tutorials/sim-time-future.mdx)** - Time management\n- **[Writing Models](./tutorials/writing-multisynq-model.mdx)** - Model patterns\n- **[Writing Views](./tutorials/writing-multisynq-view.mdx)** - View patterns\n- **[Writing Apps](./tutorials/writing-multisynq-app.mdx)** - Application structure\n- **[Random Numbers](./tutorials/random.mdx)** - Deterministic randomness\n- **[Data API](./tutorials/data-api.mdx)** - Large data handling\n\n### Essential Concepts\n- **[Synchronization](./essentials/sync.mdx)** - How real-time sync works\n- **[Collaboration](./essentials/collaboration.mdx)** - Multi-user patterns\n- **[Chat Systems](./essentials/chat.mdx)** - Real-time messaging\n- **[Whiteboard Apps](./essentials/whiteboard.mdx)** - Collaborative drawing\n- **[Conflict Resolution](./essentials/conflicts.mdx)** - Handling conflicts\n- **[Scaling](./essentials/scaling.mdx)** - Performance optimization\n\n### AI Development\n- **[Vibe Coding](./essentials/vibe-coding.mdx)** - Train AI assistants with Multisynq\n\n### React Together\nComplete documentation for React-specific development:\n- **[Getting Started](./react-together/getting-started.mdx)** - React setup\n- **[Core Hooks](./react-together/hooks/)** - useStateTogether, useFunctionTogether\n- **[Communication](./react-together/hooks/)** - useChat, useCursors\n- **[Components](./react-together/components/)** - Pre-built React components\n- **[Utilities](./react-together/utilities/)** - Helper functions\n\n### API Reference\n- **[Session API](./api-reference/session.mdx)** - Session management\n- **[Model API](./api-reference/model.mdx)** - Model lifecycle and methods\n- **[View API](./api-reference/view.mdx)** - View patterns and rendering\n\n## 🛠️ Development\n\n### Local Development\n```bash\n# Install Mintlify CLI\nnpm install -g mintlify\n\n# Start dev server\nmintlify dev\n\n# Preview at http://localhost:3000\n```\n\n### Project Structure\n```\ndocs/\n├── index.mdx              # Homepage\n├── quickstart.mdx         # Quick start guide\n├── docs.json             # Navigation config\n├── essentials/           # Core concepts\n├── tutorials/            # Interactive tutorials\n├── react-together/       # React-specific docs\n├── api-reference/        # API documentation\n├── images/              # Static assets\n└── logo/                # Brand assets\n```\n\n### Writing Documentation\n\n#### MDX Components\nUse Mintlify's built-in components:\n\n```mdx\n\u003cCard title=\"Feature\" icon=\"rocket\"\u003e\n  Description of the feature\n\u003c/Card\u003e\n\n\u003cCodeGroup\u003e\n```bash npm\nnpm install react-together\n```\n\n```bash yarn\nyarn add react-together\n```\n\u003c/CodeGroup\u003e\n\n\u003cTabs\u003e\n  \u003cTab title=\"JavaScript\"\u003e\n    Content for JS tab\n  \u003c/Tab\u003e\n  \u003cTab title=\"React\"\u003e\n    Content for React tab\n  \u003c/Tab\u003e\n\u003c/Tabs\u003e\n\n\u003cWarning\u003e\nImportant warning message\n\u003c/Warning\u003e\n\n\u003cNote\u003e\nHelpful note or tip\n\u003c/Note\u003e\n\n#### Code Examples\n- Always include working, complete examples\n- Use CDN imports for standalone examples\n- Include API key placeholders: `\"your-api-key-here\"`\n- Test all code examples before publishing\n\n#### Navigation\nUpdate `docs.json` to add new pages:\n\n```json\n{\n  \"group\": \"New Section\",\n  \"pages\": [\n    \"path/to/new-page\"\n  ]\n}\n```\n\n## 🎯 Best Practices\n\n### Content Guidelines\n1. **Accuracy**: All code examples must work with current Multisynq APIs\n2. **Completeness**: Include all necessary imports and setup\n3. **Clarity**: Explain concepts clearly with examples\n4. **Consistency**: Follow established patterns and terminology\n\n### Code Examples\n1. Use realistic app IDs: `\"com.example.myapp\"`\n2. Include error handling where appropriate\n3. Show both minimal and complete examples\n4. Test all examples in isolation\n\n### API Documentation\n1. Document all parameters and return values\n2. Include practical usage examples\n3. Note version compatibility\n4. Cross-reference related methods\n\n## 🤝 Contributing\n\n### Making Changes\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Test locally with `mintlify dev`\n5. Submit a pull request\n\n### Content Reviews\nAll content changes should be reviewed for:\n- Technical accuracy\n- Code example functionality\n- Clarity and readability\n- Consistency with existing docs\n\n## 📞 Support\n\n- **Community**: [Discord](https://discord.gg/multisynq)\n- **GitHub**: [multisynq](https://github.com/multisynq)\n- **Website**: [multisynq.io](https://multisynq.io)\n- **API Keys**: [multisynq.io/coder](https://multisynq.io/coder)\n\n## 📄 License\n\nThis documentation is part of the Multisynq platform. See individual repositories for license information.\n\n---\n\n**Built with ❤️ using [Mintlify](https://mintlify.com)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmultisynq%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmultisynq%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmultisynq%2Fdocs/lists"}