Skip to content

Add docs for messaging styles #2410

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.

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

Conversation

stefansimik
Copy link
Contributor

@stefansimik stefansimik commented Mar 5, 2025

Pull Request

New documentation: Messaging styles

Created based on hints from @faysou , @cjdsellers , @demonkoryu 🙏
Thank you all guys.

Type of change

New documentation

New documentation added

How has this change been tested?

✅ precommit passed

TODO for Chris

( @cjdsellers )

  1. New link should be placed after the existing "message_bus.md" file since it builds upon those concepts while introducing additional messaging patterns.
  2. Double check please and make proper corrections, where needed 🙏

The navigation structure would look like:

   - Architecture
   - Actors
   - Backtesting
   - Data
   - Message Bus
   - **Messaging Styles** (new content)
   - Strategies
   - ...

Why this placement?

  1. The content directly relates to both the message bus and actor concepts - serving as a bridge between these topics.
  2. The existing "Message Bus" documentation focuses primarily on the technical implementation details of the message bus itself, while this new content focuses on practical usage patterns and comparisons between different messaging approaches.

@cjdsellers
Copy link
Member

Hi @stefansimik

Thanks for the great doc! we're really getting there with adding implicit / tribal knowledge into the docs.

I'd suggest this should go either in the message bus concept guide, or the actor concept guide though? I don't think we need an entirely separate guide for this just yet? (I can move this after merge if you like? to avoid churning CI.)

On terminology, it's an interesting differentiation uncovered here: messaging pattern (e.g., pub/sub, req/res, point-to-point), vs the messaging style within a pattern.

@cjdsellers cjdsellers changed the title Add new docs - Messaging styles Add docs for messaging styles Mar 5, 2025
@stefansimik
Copy link
Contributor Author

stefansimik commented Mar 5, 2025

Thank you Chris,
feel free to relocate after merge please, if this is quick & easy for you.
Otherwise, I can do this of course 😊 👍

I had challenge to choose Actor vs. MessageBus docs, because some messaging pattern relate to MsgBus directly, other comes from using Actor/Strategy (but uses MessageBus under the hood). So this topic is interconnected with both.

Feel free to choose, which feels more natural to you 👍

(Tip: I incline to MsgBus docs a little bit more, as all messaging patterns are related to it - at least under the hood)

@cjdsellers cjdsellers merged commit aa79703 into nautechsystems:develop Mar 5, 2025
12 checks passed
@stefansimik stefansimik deleted the new_docs_messaging_styles branch March 7, 2025 22:53
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.

2 participants