From c4220af3c90bec6fb4f2e3546dbd561791eda544 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 14 Apr 2026 12:31:32 -0500 Subject: [PATCH 1/2] Add docs for what to document about a new stream --- docs/development/synapse_architecture/streams.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/development/synapse_architecture/streams.md b/docs/development/synapse_architecture/streams.md index b4057199a93..e7ab79091e9 100644 --- a/docs/development/synapse_architecture/streams.md +++ b/docs/development/synapse_architecture/streams.md @@ -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) From b3964366f67e5ba868213885c3bd8e7b5576a971 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 14 Apr 2026 12:34:25 -0500 Subject: [PATCH 2/2] Add changelog --- changelog.d/19696.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/19696.doc diff --git a/changelog.d/19696.doc b/changelog.d/19696.doc new file mode 100644 index 00000000000..c5313594446 --- /dev/null +++ b/changelog.d/19696.doc @@ -0,0 +1 @@ +Update the developer stream docs for creating a new stream to highlight places that require documentation updates.