Skip to content

docs(realtime): fix ext: import paths, clarify model selection, improve examples - #517

Merged
imorland merged 1 commit into
mainfrom
im/realtime-extender-docs-fixes
Mar 21, 2026
Merged

docs(realtime): fix ext: import paths, clarify model selection, improve examples#517
imorland merged 1 commit into
mainfrom
im/realtime-extender-docs-fixes

Conversation

@imorland

Copy link
Copy Markdown
Member

Follow-up to #516.

Summary

  • Fix all cross-extension import examples to use ext: prefix (e.g. ext:flarum/realtime/forum/extenders/Realtime) instead of the incorrect require('flarum/realtime/forum').RealtimeExtend form
  • Fix RealtimeState import path to also use ext: prefix
  • Add :::info callout explaining the ext: import convention and why it's required
  • Add "Choosing which model to return" guidance explaining when to return $event->post vs a custom model
  • Restructure the JS extender section to show the extendRealtime.ts file pattern clearly
  • Fix the complete likes example to use correct import syntax throughout

These were committed to the previous branch after the PR was merged and the branch deleted.

@imorland
imorland merged commit bcd4318 into main Mar 21, 2026
1 check passed
@imorland
imorland deleted the im/realtime-extender-docs-fixes branch March 21, 2026 00:08
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.

1 participant