velt-huddle-best-practices
Velt Huddle Best Practices
Comprehensive implementation guide for Velt's real-time audio, video, and screen sharing huddle feature. Contains 10 rules across 5 categories covering setup, configuration, webhooks, UI customization, and debugging.
When to Apply
Reference these guidelines when:
- Adding audio/video/screen sharing to a collaborative app
- Configuring huddle types (audio, video, screen, all)
- Enabling ephemeral chat within huddles
- Implementing flock mode (follow me) for shared navigation
- Adding huddle bubble on user cursors
- Handling huddle webhook events (created, joined)
- Customizing huddle tool button UI
- Debugging huddle connection or permission issues
Rule Categories by Priority
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | Core Setup | CRITICAL | core- |
| 2 | Configuration | HIGH-MEDIUM | config- |
| 3 | Events | MEDIUM | events- |
| 4 | UI Customization | MEDIUM | ui- |
| 5 | Debugging | LOW-MEDIUM | debug- |
Quick Reference
Core Setup (CRITICAL)
core-auth-provider— Use authProvider on VeltProvider, never identify()core-setup— Add VeltHuddle at app root + VeltHuddleTool in toolbarcore-document-setup— Set document context to scope huddle per document
Configuration (HIGH-MEDIUM)
config-huddle-types— Select audio/video/screen/all modeconfig-chat— Enable/disable ephemeral chat within huddleconfig-flock-mode— Follow me mode on avatar clickconfig-cursor-mode— Huddle bubble on user cursors
Events (MEDIUM)
events-webhooks— Huddle created/joined webhook integration
UI Customization (MEDIUM)
ui-customization— Slots, CSS parts, custom button templates
Debugging (LOW-MEDIUM)
debug-common-issues— Troubleshooting huddle issues
Compiled Documents
AGENTS.md— Compressed index of all rules with file paths (start here)AGENTS.full.md— Full verbose guide with all rules expanded inline
More from velt-js/agent-skills
velt-crdt-best-practices
Velt CRDT (Yjs) collaborative editing best practices for real-time applications. This skill should be used when implementing collaborative features using Velt CRDT stores, integrating with editors like Tiptap, BlockNote, CodeMirror, or ReactFlow, or debugging sync issues. Triggers on tasks involving real-time collaboration, multiplayer editing, CRDT stores, or Velt SDK integration.
28velt-comments-best-practices
Velt Comments implementation patterns and best practices for React, Next.js, and web applications. Use when adding collaborative commenting features, comment modes (Freestyle, Popover, Stream, Text, Page), rich text editor comments (TipTap, SlateJS, Lexical), media player comments, or chart comments.
27velt-setup-best-practices
Velt collaboration SDK setup guide for React, Next.js, Angular, Vue, and HTML applications. Use this skill when setting up Velt for the first time, configuring VeltProvider, implementing user authentication with authProvider and JWT tokens, initializing document collaboration with setDocuments, or debugging Velt setup issues. Triggers on any task involving Velt installation, VeltProvider configuration, auth token generation, document identity setup, or project structure for Velt integration — even if the user doesn't explicitly mention "setup".
26velt-notifications-best-practices
Velt Notifications implementation patterns and best practices for React, Next.js, and web applications. Use when adding in-app notifications, notification panels, email notifications via SendGrid, webhook integrations, or user notification preference management.
25velt-activity-best-practices
Velt Activity Logs implementation patterns and best practices for React, Next.js, and web applications. Use when adding real-time activity feeds, custom activity logging, audit trails, CRDT debounce configuration, or server-side activity management via REST API.
7velt-rest-apis-best-practices
Velt REST API v2 and webhook best practices for server-side integration. Use when calling Velt REST API v2 endpoints, generating JWT tokens for frontend authentication, handling Velt webhooks (comment events, huddle events, CRDT updates), managing users/documents/organizations via REST, or implementing server-side Velt operations. Triggers on any task involving Velt REST API, JWT token generation for Velt, Velt webhooks, x-velt-api-key headers, or server-side comment/notification/activity management — even if the user doesn't explicitly say 'REST API'. For the Python SDK (velt-py) for self-hosting, see velt-self-hosting-data-best-practices instead.
5