Add documentation for SyncIoBridge with examples and alternatives

[Nathy-bajo]

Motivation

The SyncIoBridge documentation lacked clarity on its usage, potentially leading to inefficient use and suboptimal performance. Users needed better guidance on when to use it and how to handle common use cases effectively.

Solution

This update enhances the SyncIoBridge documentation by:

•	Explaining its purpose and correct usage.
•	Providing practical examples and scenarios for effective use.
•	Highlighting alternatives to avoid blocking the async runtime.
•	Adding cross-references to related documentation.

These improvements aim to help users use SyncIoBridge more effectively and avoid common pitfalls.

Rendered

[hawkw]

Thanks for the PR!

I think that most of the examples added here don't actually compile. Before we can merge this, we need to make them compile. I left some suggestions on how to do that.

[Nathy-bajo]

Hi @hawkw.
Thank you for the suggestions! I have updated the codes.

[Nathy-bajo]

Is there anything else I need to add? @hawkw @Darksonn @tglane

[Nathy-bajo]

Hi @Darksonn
I have updated the PR. Is there anything else needed?

[tglane]

The formatting of the documentation and the examples looks about right now.

[Darksonn]

Overall LGTM, but the ignored example has warnings.

[Darksonn]

Thank you.

[Nathy-bajo]

Thank you.

Yes! Can we get this merged, please?

stale