Skip to content

docs: list supervisor workers instead of a name table - #1137

Merged
alexbouchardd merged 1 commit into
mainfrom
docs/supervisor-clarification
Oct 8, 2026
Merged

alexbouchardd merged 1 commit into
mainfrom
docs/supervisor-clarification

Conversation

@alexbouchardd

Copy link
Copy Markdown
Contributor

Summary

The Supervisor section of the configuration reference had a table that put one name per worker in three columns:

  • the name used in SUPERVISOR_RESTART_WORKERS
  • an "override key", which is the same name in uppercase
  • the /healthz name

The long Name in SUPERVISOR_RESTART_WORKERS header also made the table overflow the docs column on hookdeck.com.

This replaces the table with a list of the four workers, using the names you put in SUPERVISOR_RESTART_WORKERS. Each entry says what the worker is and how it shows up in /healthz. The overrides paragraph now says to replace <WORKER> with the worker's name in uppercase, and the overrides table uses SUPERVISOR_<WORKER>_… instead of SUPERVISOR_<KEY>_….

The worker names, uppercase env prefixes and /healthz names match internal/config/supervisor.go and the worker Name()s.

Testing

Rendered locally through the website with OUTPOST_CONTENT_PATH pointing at this branch. The Supervisor section shows the list, and no table on the page overflows.

🤖 Generated with Claude Code

The Supervisor table spread one name per worker across three columns
(restart name, override key, /healthz name), and its long header made
the table overflow the docs column. List the workers by the name used
in SUPERVISOR_RESTART_WORKERS, note how each appears in /healthz, and
describe the per-worker override prefix as the name in uppercase.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

@alexluong alexluong left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM.

@alexbouchardd
alexbouchardd merged commit 96ad42e into main Oct 8, 2026
3 checks passed
@alexbouchardd
alexbouchardd deleted the docs/supervisor-clarification branch October 8, 2026 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants