filecoin-project/specs

What is the “Libraries” section?

Closed this issue · 3 comments

I’d like to clean up the IPLD section in “Libraries” but I’m a bit confused as to what the intention of the section is.

The current content relates to Go specific libraries for these concepts, but I would assume the spec is intended to be language agnostic. I’d like to understand what this section is for, and any other areas that the IPLD team might be able to help improve the spec, but I just don’t quite understand the structure and intended audience as it is today.

This is a fair point. The libraries section is helpful if the site is "compilable", hence the go code. If the site is not compilable, then the section is not needed - perhaps it could be left there with a pointer to the respective spec for completeness.

Trading off increased usability vs compilable site vision, it has been agreed that for now we will go with a non-compilable version of the specs site and will get back to a compilable site post mainnet launch.

That said, this section of the spec is marked to be temporarily retired, or just populated with links to the projects' specs.

For reasons of completeness and in order to provide handy pointers to the several libraries that are external to Filecoin, I have decided to keep the libraries section and only provide a brief description of Multiformats, IPLD and libp2p with pointers to the corresponding specs. The PR is here: #1115

@mikeal can I get a quick review of Multiformats and IPLD, please?
@raulk the same for libp2p, please?

This section has now been updated.