Skip to content

[Docs] The "No scatter-gather" caution in routing/strategies.mdx (EN+DE) denies a router that ships, contradicting four sibling pages per language #1202

Description

@pathosDev

Where

  • docs/src/content/docs/routing/strategies.mdx → line 357, <Aside type="caution" title="No scatter-gather">
  • docs/src/content/docs/de/routing/strategies.mdx → line 375, the same aside as "Kein Scatter-Gather"

What's wrong

Both language versions of routing/strategies.mdx carry a caution telling the
reader that actor-ts has no scatter-gather router and that they must build one
themselves:

Some actor frameworks have "scatter-gather" routers that send the same message
to N routees and reply with the first / best / merged response. actor-ts
doesn't ship one; you'd build it as a custom router actor that wraps ask
over the routees and consolidates replies.

It does ship one. Router.scatterGatherFirstCompleted is implemented at
src/Router.ts:314, with a whole options family beside it
(src/ScatterGatherOptions.ts, src/ScatterGatherRouter.ts), and the feature
issue #153 that introduced it is closed.

The aside also contradicts four sibling pages in its own directory, per language:

  • routing/scatter-gather.mdx — an entire page dedicated to the router
  • routing/router.mdx
  • routing/overview.mdx
  • routing/pool-vs-group.mdx

...and their de/ mirrors. So the one page a reader lands on when comparing
strategies is the only page that denies the feature exists.

Suggested fix

Delete the aside from both strategies.mdx files, or replace it with a pointer:

Scatter-gather: see Scatter-gather
Router.scatterGatherFirstCompleted(n, Routee) sends to N routees and replies
with the first completion.

The de/ mirror gets the same change with translated prose, per the docs DoD.

Kind

Outdated — refers to a removed feature

(More precisely: it predates an added feature. The aside looks like it was
written before #153 landed and was never revisited.)

Notes

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationi18nTranslation, locale, and i18n trackingpriority: lowNice-to-have / niche / demand-driven

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions