Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create better documentation for bitswap + webpage for it #21

Open
jcalfee opened this issue Jun 20, 2016 · 6 comments
Open

Create better documentation for bitswap + webpage for it #21

jcalfee opened this issue Jun 20, 2016 · 6 comments
Labels
exp/expert Having worked on the specific codebase is important help wanted Seeking public contribution on this issue P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked

Comments

@jcalfee
Copy link

jcalfee commented Jun 20, 2016

Congratulations on having the top result at duckduckgo.com query: bitswap protocol .. Can you add a link to the main page to help users find more high level docs on the topic? tq

@jbenet
Copy link
Member

jbenet commented Jun 20, 2016

@jcalfee thanks-- we need a dedicated website and repo for the bitswap protocol. these do not exist yet.

right now (the sorry state of affairs is that) the best links are:

@jbenet
Copy link
Member

jbenet commented Jun 20, 2016

We need to:

@daviddias daviddias changed the title Add a link request Create better documentation for bitswap + webpage for it Nov 27, 2016
@daviddias daviddias added status/ready Ready to be worked status/deferred Conscious decision to pause or backlog help wanted Seeking public contribution on this issue exp/expert Having worked on the specific codebase is important and removed js-ipfs-backlog status/ready Ready to be worked status/deferred Conscious decision to pause or backlog labels Dec 5, 2016
@daviddias daviddias added status/deferred Conscious decision to pause or backlog and removed status/ready Ready to be worked labels Jan 29, 2017
@daviddias
Copy link
Member

@dgrisham wanna work on this together? With the push of docs on #76 and the recent refactor on #142, I feel it is the right time to take advantage of the current modularity and how the code is organized to write the spec for Bitswap and each of the pieces.

The full docs/spec should go into https://github.com/ipfs/specs/tree/master/bitswap and I we could deliver the full spec with a talk so that it makes it easier to digest and also force us to think thoroughly how it gets the inner workings get explained and illustrated. Fun? :D

@dgrisham
Copy link
Member

dgrisham commented Sep 3, 2017

@diasdavid Yes! I appreciate the ping, I'd love to work together on this. I'll start reviewing the existing info you linked soon.

@dgrisham
Copy link
Member

dgrisham commented Oct 9, 2017

@diasdavid Hey! Want to get on a call this week and sync on this?

@daviddias
Copy link
Member

@dgrisham let's do this :) I'll be flying Tuesday, can we try Wed, Thu or Fri? Find my availability here: https://doodle.com/daviddias

@daviddias daviddias added status/ready Ready to be worked P1 High: Likely tackled by core team if no one steps up and removed status/deferred Conscious decision to pause or backlog labels Oct 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exp/expert Having worked on the specific codebase is important help wanted Seeking public contribution on this issue P1 High: Likely tackled by core team if no one steps up status/ready Ready to be worked
Projects
None yet
Development

No branches or pull requests

4 participants