libp2p / libp2p/docs-old

Create concept doc about SecIO

Open
#8 0 comments 0 reactions 0 assignees View on GitHub

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 SecIO poster by adding a doc in the content/guides/concepts folder.

secio


See the concept docs README for more about these docs. They should strive to answer:

  1. What is this?
  2. How does it relate to the rest of Libp2p?
  3. 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.)
  4. Where do you go to learn more?
  5. What is the current state of affairs?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the concept docs README and review the SecIO poster linked in the issue, then inspect existing documents in content/guides/concepts. Create a concept document that explains what SecIO is, how it relates to Libp2p, whether and how it should be used, where to learn more, 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
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.