einherjar/telemetry
2
0
Fork 0
Code Issues Pull Requests Packages Releases 2 Activity

docs(telemetry): fix fictional launcher.Register/health.Register in doc examples #2

Merged
Rene Nochebuena merged 1 commits from fix/wiring-docs into main 2026-08-07 22:18:06 -06:00
Conversation 0 Commits 1 Files Changed 1
+2 -2
Rene Nochebuena commented 2026-08-07 22:17:28 -06:00
Owner
Copy Link
Copy Source

docs(telemetry): fix fictional launcher.Register/health.Register in doc examples

Summary

  • doc.go + README: fictional launcher.Register / health.Register -> real
    lc.Append + web/health.NewHandler(...).ServeHTTP.
    Also: launcher.BeforeStop (nonexistent) -> defer shutdown, matching the README.

Notes

Documentation-only, verified by compiling the corrected pattern against the real
API. No code, API, or dependency changes — the v1.1.0 tag will be moved to include this.

docs(telemetry): fix fictional launcher.Register/health.Register in doc examples ## Summary - doc.go + README: fictional `launcher.Register` / `health.Register` -> real `lc.Append` + `web/health.NewHandler(...).ServeHTTP`. Also: launcher.BeforeStop (nonexistent) -> defer shutdown, matching the README. ## Notes Documentation-only, verified by compiling the corrected pattern against the real API. No code, API, or dependency changes — the v1.1.0 tag will be moved to include this.
Rene Nochebuena added 1 commit 2026-08-07 22:17:29 -06:00
docs(telemetry): fix fictional launcher.Register/health.Register in doc examples 65c91552a3 
The package-doc examples showed a fictional launcher.Register / health.Register
API (and launcher.Append as a package func). Corrected to the real wiring:
lc.Append + web/health.NewHandler(...).ServeHTTP.
Also: launcher.BeforeStop (nonexistent) -> defer shutdown, matching the README.

Documentation-only. No code, API, or dependency changes; version stays v1.1.0
(the v1.1.0 tag is moved to include this fix). Verified by compiling the
corrected pattern against the real API.
Rene Nochebuena requested review from CoreDevelopers 2026-08-07 22:17:29 -06:00
Rene Nochebuena requested review from Agents 2026-08-07 22:17:29 -06:00
Rene Nochebuena merged commit d39a11e34c into main 2026-08-07 22:18:06 -06:00
Rene Nochebuena deleted branch fix/wiring-docs 2026-08-07 22:18:06 -06:00
Sign in to join this conversation.
Reviewers
No Reviewers
einherjar/CoreDevelopers
einherjar/Agents
Labels
No items
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
claude rene (Rene Nochebuena)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: einherjar/telemetry#2