Better documentation and tutorials

[rklaehn]

If I understand correctly, the intention is to have the ipfs-embed interface more or less stable from now on.

I think now would be a good time to write more documentation, including examples for how to use the different components.

• writing the docs might lead to some improvements in the APIs
• It would be very useful for people to get started with ipfs
• If the examples are checked on build, that would provide additional insurance and incentives to keep the interface stable.

[amtoine]

hello there 👋 😋

I think now would be a good time to write more documentation, including examples for how to use the different components.

is there anything being done in that direction? 😮

i am starting a new professional project about IPFS in rust 🦀
to the best of the knowledge of my team and I, the rust implementations of IPFS boil down to

• ☁️ n0-computer/iroh: cloud and mobile oriented
• 📚 rs-ipfs/rust-ipfs: is archived
• 👇 ipfs-rust/ipfs-embed: this very repo

in the end, ipfs-rust/ipfs-embed looks very cool and promising but, to be honest, i'm completely lost in the project and even struggle running it 🤔

i would love to see more documentation and a demo or end product to help users understand what the contribution of ipfs-rust/ipfs-embed is 😌 ⭐

• writing the docs might lead to some improvements in the APIs
• It would be very useful for people to get started with ipfs
• If the examples are checked on build, that would provide additional insurance and incentives to keep the interface stable.

agree with all of these 👍