Overview
The README still positions this project as a Loki-specific exporter under its old name and architecture, and documents an initiator_email Loki label that the code never actually sets. Once the sink architecture, persistence, observability, and Helm work land, the docs need a full pass to describe the real, current system rather than the original single-sink prototype.
Intent
The real intent of this issue is:
Docs that describe last quarter's single-sink prototype actively mislead anyone evaluating this project for the exact multi-sink, self-hosted-NetBird use case it now targets. This is the public face of the rename decision and the sink-architecture work, and needs to land in step with them, not trail behind.
Source of Truth
README.md: title/description still say "Loki exporter" and "Signal," the architecture Mermaid diagram shows only Signal -> Loki, and the Log Labels table documents initiator_email (admin@example.com) as a label that src/loki.rs::send_events never inserts into the labels map.
Tasks
Acceptance Criteria
- Every documented feature, label, and config option in the README is verifiably true of the current code at merge time.
- No references to the old "signal"/Loki-only framing remain.
Definition of Done
- Acceptance criteria satisfied.
- Docs PR opens only after, or alongside in the same PR as, the features it documents, not before.
- No unresolved blocker remains.
Overview
The README still positions this project as a Loki-specific exporter under its old name and architecture, and documents an
initiator_emailLoki label that the code never actually sets. Once the sink architecture, persistence, observability, and Helm work land, the docs need a full pass to describe the real, current system rather than the original single-sink prototype.Intent
The real intent of this issue is:
Source of Truth
README.md: title/description still say "Loki exporter" and "Signal," the architecture Mermaid diagram shows onlySignal -> Loki, and the Log Labels table documentsinitiator_email(admin@example.com) as a label thatsrc/loki.rs::send_eventsnever inserts into thelabelsmap.Tasks
auditbridgename and repository path.initiator_emaillabel documentation to match actual emitted labels (resolves the label drift identified in a separate tracked issue)._FILEsecrets, metrics port, cursor file path, sink selection).Acceptance Criteria
Definition of Done