wehub-resource-sync
98e40dac97
CLI Smoke Test / smoke-test-linux (20) (push) Has been cancelled
CLI Smoke Test / smoke-test-linux (24) (push) Has been cancelled
CLI Smoke Test / smoke-test-windows (20) (push) Has been cancelled
CLI Smoke Test / smoke-test-windows (24) (push) Has been cancelled
Expo App TypeScript typecheck / typecheck (push) Has been cancelled
28 lines
2.0 KiB
Markdown
28 lines
2.0 KiB
Markdown
# Happy Docs
|
|
|
|
This folder documents how Happy works internally, with a focus on protocol, backend architecture, deployment, and the CLI tool. Start here.
|
|
|
|
## Index
|
|
- protocol.md: Wire protocol (WebSocket), payload formats, sequencing, and concurrency rules.
|
|
- realtime-sync-and-rpc.md: High-level overview of realtime socket management and RPC control flow.
|
|
- api.md: HTTP endpoints and authentication flows.
|
|
- encryption.md: Encryption boundaries and on-wire encoding.
|
|
- backend-architecture.md: Internal backend structure, data flow, and key subsystems.
|
|
- deployment.md: How to deploy the backend and required infrastructure.
|
|
- cli-architecture.md: CLI and daemon architecture and how they interact with the server.
|
|
- multi-process.md: Deeper multi-replica Socket.IO + Redis streams behavior, failure modes, and integration-test history.
|
|
- dev-environments.md: Local `environments/data/` workflow, lab-rat project provisioning, `env:cli` passthrough behavior, and daemon usage.
|
|
- session-protocol.md: Unified encrypted chat event protocol.
|
|
- session-protocol-claude.md: Claude-specific session-protocol flow (local vs remote launchers, dedupe/restarts).
|
|
- plans/provider-envelope-redesign.md: Proposed replacement for the current provider/session envelope design.
|
|
- permission-resolution.md: State-based permission mode resolution across app and CLI (including sandbox behavior).
|
|
- happy-wire.md: Shared wire schemas/types package and migration notes.
|
|
- voice-architecture.md: ElevenLabs voice assistant integration, session routing, context batching, and VAD detection.
|
|
- research/: general research notes and exploratory writeups.
|
|
- competition/: competitor research, protocol analysis, and comparison notes.
|
|
- competition/AGENTS.md: structure and rules for storing competitor research results without committing raw checkouts.
|
|
|
|
## Conventions
|
|
- Paths and field names reflect the current implementation in `packages/happy-server`.
|
|
- Examples are illustrative; the canonical source is the code.
|