(DRAFT) Proposed updates to UnixFS section#1297
Closed
Conversation
Member
|
fysa proper UnixFS specs are being created in ipfs/specs#331 – may be a good idea to park technical review until we finish basic spec work |
This file contains hidden or 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
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.
PR Summary:
Updates to https://docs.ipfs.tech/concepts/file-systems/#unix-file-system-unixfs
Depends on ipfs/specs#331 (WIP)
Updates:
Todos:
Sidebar:
It might make sense to break this section into "functional" and "conceptual" parts. The "functional" content would included things like technical specs, implementation specifics, example code, "how to do XYZ with js-ipfs-unixfs", etc and the "conceptual" part could describe the data format, serialization/deserialization, import and export. Alot of that info is already on this page / in other parts of the IPFS docs, but I think that separating such info and reorganizing it would help with readability and info overload. This is sort of what I attempted here. That might be out of scope for this PR, but figured I'd mention it.