libp2p/docs

Create HTTP document

salmad3 opened this issue · 0 comments

Context

As a successor to the recent discussions and idea generation around integrating HTTP with libp2p, the libp2p stewards are defining a formal specification for HTTP in libp2p. A technical document is needed to explain the details of this integration to users and developers.

  • The working draft of the specification is currently in progress and can be found at libp2p/specs#508.
  • The goal is to also have at least one reference implementation for this specification.

Done Criteria

  • A user-friendly overview of libp2p + HTTP
  • A clear explanation of the problem or challenge in libp2p that this integration aims to address, such as limitations of traditional libp2p connections and the need for nodes to be able to offer services via HTTP.
  • A note indicating how existing request-response semantics can be mapped onto HTTP.
  • An explanation of how this integration will affect nodes that are already running, including any changes to connection types or other considerations that need to be taken into account.
  • A summary of the benefits of using HTTP in libp2p, such as increased accessibility and improved performance.
  • Identification of the best location for the document to exist, with the goal of ensuring that it is easily accessible and scalable for future updates.

Why Important

  • It is essential for readers to understand the abstraction layer that libp2p provides beyond ordered, reliable, and secure streams.
  • This document will inform users and developers about the new HTTP functionality in libp2p and make them aware of this capability.