libp2p / libp2p/docs

Create HTTP document

Open
#304 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area:http P2 type:new page
Dominant language
HTML
Stars
72
Forks
97
PR merge metrics
No merged PRs in 30d

Description

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 https://github.com/libp2p/specs/pull/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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the HTTP-in-libp2p working draft in specs pull request 508 and reviewing the existing libp2p docs site to identify the best location. Produce a user-friendly document covering the listed overview, motivation, request-response mapping, compatibility considerations, benefits, and future update location.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.