Skip to content

Add docs for what to document about a new stream #19696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MadLittleMods merged 2 commits into from
Apr 17, 2026
+8 −0
Merged

Add docs for what to document about a new stream #19696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4220af
Add docs for what to document about a new stream
MadLittleMods Apr 14, 2026
b396436
Add changelog
MadLittleMods Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/19696.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update the developer stream docs for creating a new stream to highlight places that require documentation updates.
7 changes: 7 additions & 0 deletions docs/development/synapse_architecture/streams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,13 @@ necessary registration and event handling.
- don't forget the super call
- add local-only [invalidations to your writer transactions](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/storage/databases/main/thread_subscriptions.py#L201)

**Update docs:**
- Update the [*Stream
writers*](https://github.com/element-hq/synapse/blob/develop/docs/workers.md#stream-writers)
section in the worker docs with a new section for the stream
- If this stream can only be handled by specific workers, add a new section to the
[upgrade notes](https://github.com/element-hq/synapse/blob/develop/docs/upgrade.md).

**For streams to be used in sync:**
- add a new field to [`StreamToken`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/types/__init__.py#L1003)
- add a new [`StreamKeyType`](https://github.com/element-hq/synapse/blob/4367fb2d078c52959aeca0fe6874539c53e8360d/synapse/types/__init__.py#L999)
Expand Down
Loading