Refactor: subprotocols crates

[GitGab19]

This task is an outcome of the protocols Rust docs issues tracked in #845.

While documenting protocols::v2::subprotocols in #1201, areas of potential code debt were identified. This issue servers as a place to list out these items to then be addressed in an organized manner. The initial Rust documentation effort was an immediate action, while a refactoring (which implies breaking API changes) is not so urgent priority, so for now we should leave this in the backlog for an appropriate moment in the future.

Identified Potential Code Debt

TODO

[Shourya742]

common_message_sv2: #1242 (comment)

[Shourya742]

common_message_sv2: #1242 (comment)

[Shourya742]

common_message_sv2: #1242 (comment)

[Shourya742]

template-distribution: #1257 (comment)

[Shourya742]

template-distribution: #1257 (comment)

[Shourya742]

template-distribution: #1257 (comment)

[Shourya742]

template-distribution: #1257 (comment)

[jbesraa]

One of the key things I think we are missing in the subprotocols is how to actually use them.

For example, there is no explanation how to connect to a pool and open SV2 compatible channel. Or simpler, how do I connect to a template provider.

For us this stuff is intuitive and we have roles crates as reference but I actually think the main reference should be in the subprotocols crates.

[plebhash]

One of the key things I think we are missing in the subprotocols is how to actually use them.

For example, there is no explanation how to connect to a pool and open SV2 compatible channel. Or simpler, how do I connect to a template provider.

For us this stuff is intuitive and we have roles crates as reference but I actually think the main reference should be in the subprotocols crates.

I see your point, but is that technical debt or lack of docs?