Proposal: Graphsync Public Interfaces #20
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
warpfork
reviewed
Mar 19, 2019
|
awesome docsing 👍 👍 👍 |
lanzafame
reviewed
Mar 20, 2019
|
@hannahhoward the title of the PR says Graphsync Public Interfaces, but I feel that the interface may have been drowned out by the |
momack2
approved these changes
Mar 20, 2019
|
@lanzafame I agree there's a lot of "oh and here's some go-ipld-prime stuff you need to understand to make this work". I will probably separate that out into a separate compatibility doc at some point. But for now I'm inclined to present it together since it's relevant to all the early clients of the library just to get up and running kind of. |
hannahhoward
force-pushed
the
docs/interfaces
branch
from
1a1fc2a to
dc54cee
Compare
|
Eek... I messed up something. Closing for a few minutes in case anyone is reading. |
|
Ok, sorry, problem solved. Change to initialization steps, FYI. |
Outline interfaces for using Graphsync in a readme.
Co-Authored-By: hannahhoward <[email protected]>
hannahhoward
force-pushed
the
docs/interfaces
branch
from
b81547f to
dbfeeb1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals
Outline public interfaces for using GraphSync for review by Filecoin stakeholders
I did this by completing an initial Readme documenting project usage so that once approved we'll also have documentation. Recommend choosing the rich diff view when reviewing this PR