libp2p / docs

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

Create getting started guide for nim-libp2p #245

Open salmad3 opened 1 year ago

salmad3 commented 1 year ago

Done Criteria

Why Important

Notes

p-shahi commented 1 year ago

Ideally this is something the nim-libp2p maintainers can take on and not the PL libp2p or docs team

Menduist commented 1 year ago

Very cool, thanks! We have a tutorial that looks quite similar to this on our website: https://status-im.github.io/nim-libp2p/docs/tutorial_1_connect/ Source is here: https://github.com/status-im/nim-libp2p/blob/unstable/examples/tutorial_1_connect.nim

The nice thing about having it on our repo is that we can keep it up to date more frequently when we add new sugar for instance, and make sure that it still compiles. I think rust is in the same situation as us (cc @mxinden). Having it in another repo makes it a bit harder (I have PTSD from outdated examples & tutorials :D )

But maybe we can find a way to make it work, for instance some CI action that would keep it in sync here?

Also happy to get some feedback / fixes to our tutorial!

p-shahi commented 1 year ago

@Menduist thanks, in this case, perhaps we can just create a page that links or redirects to your website. This way, we get the benefit of having a nim tutorial here without the maintenance cost.

Menduist commented 1 year ago

Yup, did that here: https://github.com/libp2p/docs/pull/265 So now we are in the same state as Rust, but you also want to move rust examples here, according to https://github.com/libp2p/docs/issues/247

mxinden commented 1 year ago

Having it in another repo makes it a bit harder (I have PTSD from outdated examples & tutorials :D )

Agreed. I think example code should live as close to the code it is showcasing as possible.