Why
@fedify/relay is small, but relay behavior is easy to misunderstand because it sits between local federation code and remote server expectations. The package has tests for Mastodon and Litepub relay flows, but the documented behavior should make the supported contract clear.
Scope
Review packages/relay/src/, packages/relay/README.md, and the manual relay documentation. Tighten the docs around what createRelay() supports, which remote relay protocols are covered, and what an application still has to configure itself.
Add focused tests where the code promises behavior that is not currently covered, especially around follow setup and actor/inbox selection. Avoid broad protocol redesign in this issue.
Suggested checks
Run mise run check-each relay and hongdown --check packages/relay/README.md docs/manual/relay.md if both documents are changed.
Why
@fedify/relayis small, but relay behavior is easy to misunderstand because it sits between local federation code and remote server expectations. The package has tests for Mastodon and Litepub relay flows, but the documented behavior should make the supported contract clear.Scope
Review packages/relay/src/, packages/relay/README.md, and the manual relay documentation. Tighten the docs around what
createRelay()supports, which remote relay protocols are covered, and what an application still has to configure itself.Add focused tests where the code promises behavior that is not currently covered, especially around follow setup and actor/inbox selection. Avoid broad protocol redesign in this issue.
Suggested checks
Run
mise run check-each relayandhongdown --check packages/relay/README.md docs/manual/relay.mdif both documents are changed.