rmv reference section, chapterize get involved and apply further redirects
This commit is contained in:
Danny Salman
parent
ebe71c95bc
commit
6ded166adf
|
|
@ -3,6 +3,7 @@ title: Core Components
|
|||
weight: 2
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
aliases: /reference/specs/
|
||||
---
|
||||
|
||||
### Chapter 2
|
||||
|
|
@ -13,3 +14,17 @@ libp2p covers a lot of ground, and may involve unfamiliar terminology and concep
|
|||
This chapter goes over the foundational concepts involved in libp2p.
|
||||
|
||||
{{% children %}}
|
||||
|
||||
### Specifications & Planning
|
||||
|
||||
While libp2p has several implementations, it is fundamentally a set of protocols for
|
||||
peer identity, discover, routing, transport, and more.
|
||||
|
||||
See the [specifications repository](https://github.com/libp2p/specs) for the offical libp2p specifications.
|
||||
|
||||
### Implementations
|
||||
|
||||
At the core of libp2p is a set of specifications, which together
|
||||
form the definition for what libp2p is in the abstract and what makes a "correct" libp2p
|
||||
implementation. Keep up with the latest implementations on the
|
||||
[libp2p implementations page](https://libp2p.io/implementations/).
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ weight: 1
|
|||
pre: '<i class="fas fa-fw fa-book"></i> <b>2.11.1 </b>'
|
||||
chapter: true
|
||||
summary: A list of words, phrases, and abbreviations related to libp2p.
|
||||
aliases: /reference/glossary/
|
||||
---
|
||||
|
||||
### Chapter 2.11.1
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
title: "Get Involved"
|
||||
weight: 5
|
||||
pre: "<b>5. </b>"
|
||||
weight: 4
|
||||
pre: "<b>4. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Chapter 5
|
||||
### Chapter 4
|
||||
|
||||
# Get Involved with libp2p
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,14 @@
|
|||
---
|
||||
title: "Community"
|
||||
weight: 2
|
||||
pre: '<i class="fas fa-fw fa-book"></i> <b>5.2 </b>'
|
||||
pre: '<i class="fas fa-fw fa-book"></i> <b>4.2 </b>'
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Chapter 4.2
|
||||
|
||||
# Community
|
||||
|
||||
We love talking about libp2p, and we'd be happy to have you in the mix.
|
||||
|
||||
Visit our [discussion forums](https://discuss.libp2p.io) to ask questions about [using libp2p](https://discuss.libp2p.io/c/users), discuss exciting [research](https://discuss.libp2p.io/c/research), and [stay up to date with important announcments](https://discuss.libp2p.io/c/news).
|
||||
|
|
|
|||
|
|
@ -1,26 +1,32 @@
|
|||
---
|
||||
title: "How to Contribute"
|
||||
weight: 1
|
||||
pre: '<i class="fas fa-fw fa-book"></i> <b>5.1 </b>'
|
||||
pre: '<i class="fas fa-fw fa-book"></i> <b>4.1 </b>'
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Chapter 4.1
|
||||
|
||||
# How to Contribute
|
||||
|
||||
So you want to contribute to libp2p and the peer-to-peer ecosystem? Here is a quick listing
|
||||
of things we need help with and how you can get started. Even if what you want
|
||||
to do is not listed here, we probably accept contributions for it! If you're
|
||||
unsure, please open a issue.
|
||||
|
||||
## Areas of contribution
|
||||
- [Areas of contribution](#areas-of-contribution)
|
||||
- [Code](#code)
|
||||
- [Documentation](#documentation)
|
||||
- [Support](#support)
|
||||
- [Testing](#testing)
|
||||
- [Design](#design)
|
||||
- [Issues / Triaging](#issues--triaging)
|
||||
- [Community](#community)
|
||||
- [Applications](#applications)
|
||||
- [Protocol Design](#protocol-design)
|
||||
- [Research](#research)
|
||||
- [How to Contribute](#how-to-contribute)
|
||||
- [Areas of contribution](#areas-of-contribution)
|
||||
- [Code](#code)
|
||||
- [Documentation](#documentation)
|
||||
- [Support](#support)
|
||||
- [Testing](#testing)
|
||||
- [Design](#design)
|
||||
- [Issues / Triaging](#issues--triaging)
|
||||
- [Community](#community)
|
||||
- [Applications](#applications)
|
||||
- [Protocol Design](#protocol-design)
|
||||
- [Research](#research)
|
||||
|
||||
### Code
|
||||
|
||||
|
|
|
|||
|
|
@ -5,6 +5,8 @@ pre: "<b>3. </b>"
|
|||
chapter: true
|
||||
---
|
||||
|
||||
### Chapter 3
|
||||
|
||||
# Get Started with libp2p
|
||||
|
||||
## Examples using libp2p
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
title: "Reference"
|
||||
weight: 4
|
||||
pre: "<b>4. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Chapter 4
|
||||
|
||||
# Reference Documentation
|
||||
|
||||
This chapter includes the reference documentation available for libp2p.
|
||||
|
||||
{{% children %}}
|
||||
|
||||
{{% notice "note" %}}
|
||||
This section is incomplete, and many of the articles are stubs. To help fill in
|
||||
the gaps, please see the issues linked in each article to add your input and
|
||||
help us prioritize the outstanding work.
|
||||
{{% /notice %}}
|
||||
|
|
@ -1,39 +0,0 @@
|
|||
---
|
||||
title: "Overview"
|
||||
weight: 1
|
||||
pre: '<i class="fas fa-fw fa-book"></i> <b>4.1. </b>'
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Chapter 4.1
|
||||
|
||||
# Overview
|
||||
|
||||
This section contains in-depth reference material, including a [glossary](/reference/glossary/) with definitions of libp2p terminology.
|
||||
|
||||
### Specifications & Planning
|
||||
|
||||
While libp2p has several implementations, it is fundamentally a set of protocols for
|
||||
peer identity, discover, routing, transport and more.
|
||||
|
||||
See the [specifications section](/reference/specs/) for details.
|
||||
|
||||
### Implementations
|
||||
|
||||
At the core of libp2p is a set of [specifications](/reference/specs/), which together
|
||||
form the definition for what libp2p is in the abstract and what makes a "correct" libp2p
|
||||
implementation. Today, implementations of libp2p exist in several languages, with varying degrees
|
||||
of completeness. The most complete implementations are in [Go](/reference/go/),
|
||||
[JavaScript](/reference/js/), and [Rust](https://github.com/libp2p/rust-libp2p).
|
||||
|
||||
In addition to the implementations above, the libp2p community is actively working on
|
||||
implementations in [python](https://github.com/libp2p/py-libp2p) and [the JVM via Kotlin](https://github.com/web3j/libp2p). Please check the project pages for each implementation to see its status and current
|
||||
state of completeness.
|
||||
|
||||
Please help make this section more complete by [filing an issue](https://github.com/libp2p/docs/issues/new).
|
||||
|
||||
{{% notice "note" %}}
|
||||
This section is incomplete, and many of the articles are stubs. To help fill in
|
||||
the gaps, please see the issues linked in each article to add your input and
|
||||
help us prioritize the outstanding work.
|
||||
{{% /notice %}}
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
---
|
||||
title: "Specifications"
|
||||
weight: 2
|
||||
pre: '<i class="fas fa-fw fa-book"></i> <b>4.2. </b>'
|
||||
chapter: true
|
||||
summary: Learn about the official libp2p specifications.
|
||||
---
|
||||
|
||||
### Chapter 4.2
|
||||
|
||||
# Specifications
|
||||
|
||||
Check out the [specs repo](https://github.com/libp2p/specs) for details about the libp2p architecture.
|
||||
Loading…
Reference in New Issue