Skip to content
This repository has been archived by the owner on Jun 2, 2020. It is now read-only.

Write concept doc on peers and peer IDs #96

Closed
Mr0grog opened this issue Jul 25, 2018 · 2 comments
Closed

Write concept doc on peers and peer IDs #96

Mr0grog opened this issue Jul 25, 2018 · 2 comments
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week help wanted Seeking public contribution on this issue topic/design-content Content design, writing, information architecture topic/docs Documentation

Comments

@Mr0grog
Copy link
Collaborator

Mr0grog commented Jul 25, 2018

This issue is part of Epic 3B: Fixes from legacy issue queue.

At the Berlin developer summit, we decided Peers and Peer IDs were important to write a concept doc about.

These are tightly related enough that we could probably just have one doc covering both and name it “Peers and Peer IDs,” “Peer/Peer ID,” “Peer(ID),” or something along those lines.

We did not have time to write a rough draft, so this needs to be written from scratch.

This is a subtask of #56.


Concept docs are concise, high-level descriptions of various core concepts in IPFS. They live in the content/guides/concepts folder and should strive to answer:

  1. What is this?
  2. How does it relate to the rest of IPFS?
  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?
@Mr0grog Mr0grog added P2 - Medium help wanted Seeking public contribution on this issue labels Jul 25, 2018
@meiqimichelle meiqimichelle added topic/design-content Content design, writing, information architecture and removed content labels Jun 4, 2019
@jessicaschilling jessicaschilling added docs-ipfs dif/medium Prior experience is likely helpful labels Jul 25, 2019
@jessicaschilling jessicaschilling changed the title Write concept doc for Peer and Peer ID Concept Doc: Peer and Peer ID Jul 26, 2019
@jessicaschilling jessicaschilling changed the title Concept Doc: Peer and Peer ID Write concept doc on peers and peer IDs Sep 19, 2019
@jessicaschilling jessicaschilling added topic/docs Documentation effort/days Estimated to take multiple days, but less than a week labels Sep 19, 2019
@jessicaschilling
Copy link
Contributor

libp2p has addressed this - see libp2p/docs#35 .

@jessicaschilling
Copy link
Contributor

Closing this issue, since it's been addressed by the libp2p folks (https://docs.libp2p.io/concepts/peer-id/) and we're including some form of a basic libp2p guide in the docs beta: cf https://github.com/ipfs/ipfs-docs-v2

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week help wanted Seeking public contribution on this issue topic/design-content Content design, writing, information architecture topic/docs Documentation
Projects
None yet
Development

No branches or pull requests

3 participants