Create concept doc about Floodsub
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
At the IPFS/Libp2p developer summit in Berlin in July 2018, we had poster-making sessions where people explored various Libp2p concepts. We should expand on the Floodsub poster by adding a doc in the content/guides/concepts folder.
See the concept docs README for more about these docs. They should strive to answer:
- What is this?
- How does it relate to the rest of Libp2p?
- How can (or should?) you use it? (Note: sometimes the answer is that you should understand it, but not use it. Bitswap is probably a good example.)
- Where do you go to learn more?
- What is the current state of affairs?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the concept docs README and the existing files in content/guides/concepts. Use the Floodsub poster and the README guidance to structure a new concept document covering what Floodsub is, its relationship to Libp2p, how it should be used, further learning resources, and its current state.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100