EchoHub/docs/auriondocs/README.md

HueByte/EchoHub — Documentation

Continuously generated, source-verified documentation for HueByte/EchoHub, built from branch master at commit 4dcb480d. Every page is derived from the code itself and cross-checked against the source before it ships.

EchoHub is a client/server chat system that exposes an HTTP API implemented by multiple controllers and a realtime messaging surface via a hub (ChatHub), with client-side components for connecting and playback. The server hosts application services and background workers (e.g. file cleanup, data migrations) that implement business logic and maintenance tasks. Persistent state is stored in the Entity Framework DbContext (EchoHubDbContext) which is used by controllers and services. Clients interact with the server through the ApiClient and implement messaging callbacks against the IEchoHubClient contract.

Start here

1. Architecture — the system overview: what the components are, how they collaborate, and where to find each one.
2. Onboarding — a curated reading path through the codebase. Start here if you're new to the project.
3. Code reference — per-file API documentation mirroring the source tree, one page per documented file.

Deep dives

Cross-file guides on the themes that shape this codebase:

• API client and authentication — This guide explains how the EchoHub client performs HTTP operations and manages authentication tokens, and it documents the DTOs the client uses when talking to the server.
• Attachments and file transfers — Outgoing attachments are staged in the UI, packaged as transport objects, and then coordinated through the app orchestrator into the live connection for transmission.
• Clipboard utilities — This guide describes the clipboard-focused utilities in the client: one helper that exposes file-list clipboard contents, another that normalizes image clipboard data into PNG bytes, and the UI entry points that call…
• Command handling — This guide explains how user-entered slash commands move from text input into application behavior and network actions.
• Encryption and room key management — End-to-end encryption in the client is implemented as a few focused components: a runtime encryptor that mirrors the server format, a protector that encrypts per-channel room keys at rest, a store that binds persisted…
• Real-time connection management — This guide explains how the client-side pieces manage a SignalR-based chat connection, surface server events to the UI, and carry message and attachment DTOs across those boundaries.
• Theming and UI color management — Theming and UI color management
• Update management — Update management

Recurring workflows

Step-by-step templates for the patterns this codebase repeats, each grounded in real examples from the source:

• Adding a new controller
• Adding a new service

By the numbers

• 128 documentation pages covering 128 source files
• 598 symbols documented and validated
• 22,133 lines of code analyzed
• Languages: C# (128)

How these docs are organized

• Code/ mirrors the repository's source tree one-to-one — src/Foo.cs is documented at Code/src/Foo.cs.md.
• Synthesis/ holds knowledge derived across files: the architecture overview, onboarding path, topic deep-dives, and workflow templates.
• The set is regenerated as the code changes; drift between code and docs is detected and repaired automatically.

---

Generated by AurionDocs from master at commit 4dcb480d on 2026-07-23 05:56 UTC.