Documentation index
End users
| Doc | Contents |
|---|---|
| User guide | Desktop workflows: Connect, Overview, Charts, Metric Correlations, Logs, Containers, Related, Alerts, Fleet, Settings (Data Manager) |
| GETTING-STARTED.md | Install agent / desktop, first dial, systemd (journal + Docker socket when detected) |
Engineers & operators
| Doc | Audience | Contents |
|---|---|---|
| ROADMAP.md | Everyone | Phased MVP → advanced real-time features |
| ARCHITECTURE.md | Engineers | Planes, PearDock mapping, module map |
| PROTOCOL.md | Protocol owners | RPC methods, pushes, versioning |
| DATA-MODEL.md | Engineers | Metrics, anomalies, alerts, jobs, weights, logs |
| REST-API.md | Integrators | agent-style /api/v1|v2|v3 |
| DASHBOARD.md | UI developers | Charts wall / Correlate / Related product plan |
| TECH-CHOICES.md | Engineers | Collector, charts, libraries |
| STORAGE-HYPERDB.md | Engineers | HyperDB / Corestore / Autobase + Data Manager retention |
| DESKTOP.md | UI developers | Pear shell, titlebar, identity, Data Manager / Logs |
| SECURITY.md | Operators / security | Trust model, secrets, journal / Docker socket hardening |
| CONFIGURATION.md | Operators | Full env vars + npm scripts (retention seeds, Docker) |
| TESTING.md | Contributors | brittle, soak, manual QA |
| CI.md | Maintainers | GitHub/Gitea pipelines |
| RELEASE.md | Maintainers | Version, tag, tarball |
| EXTENDING.md | Product builders | New charts, collectors, parents |
| SWAGGER_PLAN.md | Integrators | Endpoint parity tracker |
Start here (ops): GETTING-STARTED.md · Day-to-day UI: User guide · Product overview: ../README.md.
License: AGPL-3.0-only.