search

libp2p / docs

Documentation site for the libp2p project.
https://docs.libp2p.io/
Other
60 stars 88 forks source link

Add getting started guide for rust-libp2p #247

Open salmad3 opened 1 year ago

salmad3 commented 1 year ago

Done Criteria

TO DO

Why Important

For a long time, this content has only referenced the rust-libp2p examples directory.

mxinden commented 1 year ago

For the reasons outlined by @Menduist in https://github.com/libp2p/docs/issues/245#issuecomment-1337610963 I don't think we should move the Rust examples here, unless we can enforce in an automated way that they will never be outdated. I think setting up such automation is worth the benefit. In other words, I suggest keeping the Rust example code in the rust-libp2p repository.

salmad3 commented 1 year ago

The proposal is to have at least one getting started-like guide similar to Go and JS. We can continue to refer to the examples in the rust-libp2p repo.