Skip to content

Commit 4c2b7fc

Browse files
committed
more toc, edits
1 parent 410641f commit 4c2b7fc

File tree

7 files changed

+47
-28
lines changed

7 files changed

+47
-28
lines changed

content/get-involved/_index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
title: "Get Involved"
33
weight: 5
44
pre: "<b>5. </b>"
5+
chapter: true
56
---
67

8+
### Chapter 5
9+
10+
# Get Involved
11+
712
{{% children description="true" %}}
813

914
{{% notice "note" %}}

content/guides/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ chapter: true
1212
The guides section of the libp2p documentation hub is a developer portal
1313
containing how-to guides, technical tutorials, and examples for each libp2p implementation.
1414

15-
{{% children %}}
15+
{{% children description="true" %}}
1616

1717
{{% notice "note" %}}
1818
This section is incomplete, and many of the articles are stubs. To help fill in

content/guides/examples/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ pre: '<i class="fas fa-fw fa-book"></i> <b>3.3. </b>'
66

77
Stay tuned for libp2p examples!
88

9+
{{% children description="true" %}}
10+
911
{{% notice "note" %}}
1012
This section is incomplete, and many of the articles are stubs. To help fill in
1113
the gaps, please see the issues linked in each article to add your input and

content/guides/protocol-basics/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ for each of its main implementations:
1111
* For javascript, see the [/examples directory of the js-libp2p repo](https://github.com/libp2p/js-libp2p/tree/master/examples).
1212
* For rust, see [/examples directory of the rust-libp2p repo](https://github.com/libp2p/rust-libp2p/tree/master/examples).
1313

14-
{{% children %}}
14+
{{% children description="true" %}}
1515

1616
{{% notice "note" %}}
1717
This section is incomplete, and many of the articles are stubs. To help fill in

content/introduction/_index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ chapter: true
77

88
### Chapter 1
99

10-
# Get Started with libp2p
10+
# Get Started with Networking
11+
12+
{{% children description="true" %}}
13+
14+
{{% notice "note" %}}
15+
This section is incomplete, and many of the articles are stubs. To help fill in
16+
the gaps, please see the issues linked in each article to add your input and
17+
help us prioritize the outstanding work.
18+
{{% /notice %}}
1119

12-
Whether you’re just starting to dive into peer-to-peer concepts and
13-
solutions, learning how to build peer-to-peer systems with libp2p, or
14-
are looking for detailed reference information, this is the place to
15-
start.

content/reference/_index.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,10 @@ chapter: true
99

1010
# Reference Documentation
1111

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

14-
### Specifications & Planning
15-
16-
While libp2p has several implementations, it is fundamentally a set of protocols for
17-
peer identity, discover, routing, transport and more.
18-
19-
See the [specifications section](/reference/specs/) for details.
20-
21-
### Implementations
22-
23-
At the core of libp2p is a set of [specifications](/reference/specs/), which together
24-
form the definition for what libp2p is in the abstract and what makes a "correct" libp2p
25-
implementation. Today, implementations of libp2p exist in several languages, with varying degrees
26-
of completeness. The most complete implementations are in [Go](/reference/go/),
27-
[JavaScript](/reference/js/), and [Rust](https://github.com/libp2p/rust-libp2p).
28-
29-
In addition to the implementations above, the libp2p community is actively working on
30-
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
31-
state of completeness.
32-
33-
Please help make this section more complete by [filing an issue](https://github.com/libp2p/docs/issues/new).
14+
{{% notice "note" %}}
15+
This section is incomplete, and many of the articles are stubs. To help fill in
16+
the gaps, please see the issues linked in each article to add your input and
17+
help us prioritize the outstanding work.
18+
{{% /notice %}}

content/reference/overview.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,29 @@ weight: 1
44
pre: '<i class="fas fa-fw fa-book"></i> <b>4.1. </b>'
55
---
66

7+
This section contains in-depth reference material, including a [glossary](/reference/glossary/) with definitions of libp2p terminology.
8+
9+
### Specifications & Planning
10+
11+
While libp2p has several implementations, it is fundamentally a set of protocols for
12+
peer identity, discover, routing, transport and more.
13+
14+
See the [specifications section](/reference/specs/) for details.
15+
16+
### Implementations
17+
18+
At the core of libp2p is a set of [specifications](/reference/specs/), which together
19+
form the definition for what libp2p is in the abstract and what makes a "correct" libp2p
20+
implementation. Today, implementations of libp2p exist in several languages, with varying degrees
21+
of completeness. The most complete implementations are in [Go](/reference/go/),
22+
[JavaScript](/reference/js/), and [Rust](https://github.com/libp2p/rust-libp2p).
23+
24+
In addition to the implementations above, the libp2p community is actively working on
25+
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
26+
state of completeness.
27+
28+
Please help make this section more complete by [filing an issue](https://github.com/libp2p/docs/issues/new).
29+
730
{{% notice "note" %}}
831
This section is incomplete, and many of the articles are stubs. To help fill in
932
the gaps, please see the issues linked in each article to add your input and

0 commit comments

Comments
 (0)