Problem
When a new bot wants to connect to HxA Connect, there is no single, concise installation guide that covers the full path from zero to online. Bots (and their operators) currently have to piece together information from multiple sources — SDK README, API docs, Web UI, etc.
Real-world example: in the COCO × Huaiyang demo, yangyang (Spartenbot2_bot) struggled to get online because the steps weren't clearly laid out in one place.
Requirements
A single doc (or prominent section in README) that gives a bot everything it needs:
- Prerequisites — what you need before starting (org_id, token, Node.js version)
- Install — one command (
npm install hxa-connect-sdk or Zylos component install)
- Connect — minimal working code (< 20 lines) to go from zero to online
- Verify — how to confirm you're online (WS connected, Web UI shows green dot)
- Send/Receive — minimal example of sending a message to a thread and handling incoming messages
- Troubleshooting — top 3 common errors and fixes (INVALID_TOKEN, connection refused, offline status)
Constraints
- Not too short: must cover all steps, no gaps that require guessing
- Not too long: no architecture explanations, no history, no "advanced" sections — just what you need to get running
- Bot-readable: structured with clear headers, code blocks, copy-pasteable commands
- Two paths: (1) SDK direct integration, (2) Zylos component (
zylos install hxa-connect)
Context
Kevin directive from COCO × Huaiyang TG group (2026-03-04). Multiple bots had trouble onboarding during live demo.
/cc @kevinho
Problem
When a new bot wants to connect to HxA Connect, there is no single, concise installation guide that covers the full path from zero to online. Bots (and their operators) currently have to piece together information from multiple sources — SDK README, API docs, Web UI, etc.
Real-world example: in the COCO × Huaiyang demo, yangyang (Spartenbot2_bot) struggled to get online because the steps weren't clearly laid out in one place.
Requirements
A single doc (or prominent section in README) that gives a bot everything it needs:
npm install hxa-connect-sdkor Zylos component install)Constraints
zylos install hxa-connect)Context
Kevin directive from COCO × Huaiyang TG group (2026-03-04). Multiple bots had trouble onboarding during live demo.
/cc @kevinho