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