Skip to content

Update from code changes: RegisterAsDispatchListener and READY guildDelete - #94

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ed6708b7
Open

mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/ed6708b7

Conversation

@mintlify

@mintlify mintlify Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new RegisterAsDispatchListener decorator and the forwarding of the GUILD_DELETE the client emits for guilds a READY no longer lists.

Changes

  • plugin-gateway: new "Run a listener on one process" section under Listeners (behavior, client.forwardsDispatches, rejected gateway-only events, events filter and idempotency caveats).
  • plugin-gateway: Replaying dispatches now explains READY guild reconciliation and its dispatch emission as GUILD_DELETE.
  • plugin-broker: forwardGatewayDispatches notes the forwarded READY GUILD_DELETE and adds a "Run listeners on the workers only" subsection.

Context

@mintlify
mintlify Bot requested a review from RedStar071 as a code owner October 20, 2026 07:11
@coldtea-pr-lens

Copy link
Copy Markdown

Note

mintlify[bot] opened this pull request, so PR Lens left it undrawn. Comment @pr-lens draw to draw it

github.comment.notice: false in .github/pr-lens.yml turns this note off

@wolfstarbot wolfstarbot added the content:packages Changes in documentation/packages/ (package landing pages) label Oct 20, 2026
@mintlify

mintlify Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
stars-components 🟢 Ready View Preview Oct 20, 2026, 7:13 AM

@mintlify

mintlify Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
stars-components 🟡 Building – Oct 20, 2026, 7:11 AM

@pullfrog

pullfrog Bot commented Oct 20, 2026

Copy link
Copy Markdown

The ci check fails on this PR's pnpm lint step. oxfmt --check reports a formatting issue in documentation/packages/plugin-gateway.mdx: the <Warning> block near the end of the new "Run a listener on one process" section wraps lines at the wrong width.

Fix: run pnpm lint:fix. It rewraps those two lines and changes nothing else. The only touched file is documentation/packages/plugin-gateway.mdx, which this PR already changes.

 <Warning>
-	With `events` set on `forwardGatewayDispatches`, a listener of an event built from a dispatch that is not forwarded runs
-	nowhere. Workers receive dispatches at least once, so keep the listener idempotent.
+	With `events` set on `forwardGatewayDispatches`, a listener of an event built from a dispatch that is not forwarded runs nowhere. Workers receive
+	dispatches at least once, so keep the listener idempotent.
 </Warning>

Verification: after the fix, pnpm lint passes (oxlint reports 0 warnings and 0 errors, and oxfmt --check reports all files correctly formatted). I did not run mint validate because it hangs in the runner sandbox. The failed job logs were unavailable, so I reproduced the failure locally instead.

Blocker: I committed the fix locally as style(packages): format plugin-gateway mdx with oxfmt, but push_branch refused to push it. This run isn't scoped to PR #94. Nothing has been pushed.

Next step: apply the diff above by running pnpm lint:fix on the mintlify/ed6708b7 branch and committing. Alternatively, re-trigger the repair run directly against this PR.

Pullfrog  | View workflow run | via Pullfrog | Using claude-sonnet-5-5 | 𝕏

This branch was successfully deployed

1 active deployment
staging — d68e7c74 Deployed Oct 20, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:packages Changes in documentation/packages/ (package landing pages)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant