Need CI/CD for Rust Docs

[rrybarczyk]

Currently there is no checks to ensure the cargo documentation builds. To ensure no code changes break documentation, we need to ensure that cargo doc --all-features passes for every crate.

[plebhash]

it should be sufficient to have a new workflow file that simply runs cargo doc --all-features under the protocols workspace

[plebhash]

this is not a comprehensive analysis (maybe more crates are broken), but I tried it locally and it seems template_distribution_sv2 is broken:

    Checking template_distribution_sv2 v1.0.3 (/Users/plebhash/develop/stratum/protocols/v2/subprotocols/template-distribution)
error[E0433]: failed to resolve: use of undeclared type `Vec`
   --> v2/subprotocols/template-distribution/src/new_template.rs:209:28
    |
209 |             let mut path = Vec::new();
    |                            ^^^ use of undeclared type `Vec`
    |
help: consider importing one of these items
    |
7   + use alloc::vec::Vec;
    |
7   + use crate::vec::Vec;
    |

error[E0433]: failed to resolve: use of undeclared type `Vec`
   --> v2/subprotocols/template-distribution/src/new_template.rs:230:34
    |
230 |             coinbase_tx_outputs: Vec::new().try_into().unwrap(),
    |                                  ^^^ use of undeclared type `Vec`
    |
help: consider importing one of these items
    |
7   + use alloc::vec::Vec;
    |
7   + use crate::vec::Vec;
    |

error[E0599]: no method named `try_into` found for struct `Vec<u8>` in the current scope
   --> v2/subprotocols/template-distribution/src/new_template.rs:195:66
    |
195 |         let coinbase_prefix: binary_sv2::B0255 = coinbase_prefix.try_into().unwrap();
    |                                                                  ^^^^^^^^
    |
   ::: /Users/plebhash/.rustup/toolchains/1.78-aarch64-apple-darwin/lib/rustlib/src/rust/library/core/src/convert/mod.rs:611:8
    |
611 |     fn try_into(self) -> Result<T, Self::Error>;
    |        -------- the method is available for `Vec<u8>` here
    |
    = help: items from traits can only be used if the trait is in scope
    = note: 'core::convert::TryInto' is included in the prelude starting in Edition 2021
help: trait `TryInto` which provides `try_into` is implemented but not in scope; perhaps you want to import it
    |
1   + use core::convert::TryInto;
    |
help: there is a method `into` with a similar name
    |
195 |         let coinbase_prefix: binary_sv2::B0255 = coinbase_prefix.into().unwrap();
    |                                                                  ~~~~

Some errors have detailed explanations: E0433, E0599.
For more information about an error, try `rustc --explain E0433`.
error: could not compile `template_distribution_sv2` (lib) due to 3 previous errors
warning: build failed, waiting for other jobs to finish...

cc @jbesraa

[plebhash]

ok after digging a bit, it seems the error on template_distribution_sv2 is likely related to the no_std flag

AFAIU @Georges760 #1230 is yet to send a PR addressing that on subprotocols crates, so we should probably wait until this is sorted out before we proceed on enforcing --all-features for subprotocols

for now, subprotocols crates should be published without --all-features

[Georges760]

--all-features breaks a lot of protocols/v2 crates, even before #1230 merge.

for instance, codec_sv2 cargo build is broken with --all-features since a long time. Neither #1230 or #1238 or the next PR specific to codec_sv2 for no_std (ready for after #1238) will solve this issue, because it is not related to the std feature, but more to the with_serde and with_buffer_pool features.

During my no_std quest I noticed that and reported it somewhere, but didn't consider it as my main task, specially because i was told the with_serde feature will be deprecated.