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

ipld: change docs to remove mention of IPFS #112

Closed
renaynay opened this issue Oct 5, 2021 · 5 comments
Closed

ipld: change docs to remove mention of IPFS #112

renaynay opened this issue Oct 5, 2021 · 5 comments
Assignees
Labels
area:ipld IPLD plugin docs:godocs Related to documentation of packages / code good first issue Good for newcomers

Comments

@renaynay
Copy link
Member

renaynay commented Oct 5, 2021

No description provided.

@renaynay renaynay self-assigned this Oct 5, 2021
@renaynay renaynay added the area:ipld IPLD plugin label Oct 6, 2021
@Wondertan
Copy link
Member

IPLD Plugin = IPFS plugin. There is no reason to remove IPFS docs until the plugin exists. This might be confusing, but IPLD does not have the concept of plugins whatsoever and only codecs. So our ipld/plugin code is a plugin for IPFS implementing NMT codec with IPLD.

Although, I am ok to remove the plugin with supporting IPFS docs entirely, as we don't have a use case for NMT to be used directly in IPFS.

cc @liamsi, as the original designer of the plugin.

@liamsi
Copy link
Member

liamsi commented Oct 15, 2021

I'm not sure which docs this refers to tbh.

@liamsi
Copy link
Member

liamsi commented Apr 14, 2022

Is it these two mentions that are confusing?

// RetrieveData asynchronously fetches block data using the minimum number
// of requests to IPFS. It fails if one of the random samples sampled is not available.

// PutData posts erasured block data to IPFS using the provided ipld.NodeAdder.

I kinda agree as this sounds like we are using the public IPFS network. Should be a simple fix to mention that this is done via bitswap now. Or simply say that this is done on the p2p layer without even stating how.

@liamsi liamsi added docs:godocs Related to documentation of packages / code good first issue Good for newcomers labels Apr 14, 2022
@Wondertan
Copy link
Member

These mentions were removed so closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:ipld IPLD plugin docs:godocs Related to documentation of packages / code good first issue Good for newcomers
Projects
No open projects
Archived in project
Development

No branches or pull requests

3 participants