Skip to content

Commit

Permalink
more toc, edits
Browse files Browse the repository at this point in the history
salmad3 committed Sep 13, 2022
1 parent 410641f commit 4c2b7fc
Showing 7 changed files with 47 additions and 28 deletions.
5 changes: 5 additions & 0 deletions content/get-involved/_index.md
Original file line number Diff line number Diff line change
@@ -2,8 +2,13 @@
title: "Get Involved"
weight: 5
pre: "<b>5. </b>"
chapter: true
---

### Chapter 5

# Get Involved

{{% children description="true" %}}

{{% notice "note" %}}
2 changes: 1 addition & 1 deletion content/guides/_index.md
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ chapter: true
The guides section of the libp2p documentation hub is a developer portal
containing how-to guides, technical tutorials, and examples for each libp2p implementation.

{{% children %}}
{{% children description="true" %}}

{{% notice "note" %}}
This section is incomplete, and many of the articles are stubs. To help fill in
2 changes: 2 additions & 0 deletions content/guides/examples/_index.md
Original file line number Diff line number Diff line change
@@ -6,6 +6,8 @@ pre: '<i class="fas fa-fw fa-book"></i> <b>3.3. </b>'

Stay tuned for libp2p examples!

{{% children description="true" %}}

{{% 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
2 changes: 1 addition & 1 deletion content/guides/protocol-basics/_index.md
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ for each of its main implementations:
* For javascript, see the [/examples directory of the js-libp2p repo](https://github.com/libp2p/js-libp2p/tree/master/examples).
* For rust, see [/examples directory of the rust-libp2p repo](https://github.com/libp2p/rust-libp2p/tree/master/examples).

{{% children %}}
{{% children description="true" %}}

{{% notice "note" %}}
This section is incomplete, and many of the articles are stubs. To help fill in
14 changes: 9 additions & 5 deletions content/introduction/_index.md
Original file line number Diff line number Diff line change
@@ -7,9 +7,13 @@ chapter: true

### Chapter 1

# Get Started with libp2p
# Get Started with Networking

{{% children description="true" %}}

{{% 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 %}}

Whether you’re just starting to dive into peer-to-peer concepts and
solutions, learning how to build peer-to-peer systems with libp2p, or
are looking for detailed reference information, this is the place to
start.
27 changes: 6 additions & 21 deletions content/reference/_index.md
Original file line number Diff line number Diff line change
@@ -9,25 +9,10 @@ chapter: true

# Reference Documentation

This section contains in-depth reference material, including a [glossary](/reference/glossary/) with definitions of libp2p terminology.
{{% children description="true" %}}

### 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 %}}
23 changes: 23 additions & 0 deletions content/reference/overview.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,29 @@ weight: 1
pre: '<i class="fas fa-fw fa-book"></i> <b>4.1. </b>'
---

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

0 comments on commit 4c2b7fc

Please sign in to comment.