Skip to content

Commit c240fb3

Browse files
salmad3salmad3
committed
edits edits
1 parent 3758724 commit c240fb3

File tree

28 files changed

+53
-37
lines changed

28 files changed

+53
-37
lines changed

‎config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ relativeURLs = true
33
languageCode = "en-us"
44
title = "libp2p Documentation"
55

6-
theme = "hugo-theme-learn"
6+
theme = ["hugo-theme-learn"]
77

88
[params]
99
themeVariant = "libp2p"

‎content/_index.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,38 @@
11
---
2-
title: Welcome to the libp2p documentation portal
2+
title: libp2p book
33
menuTitle: libp2p
44
weight: 1
55
pre: "<b>1. </b>"
66
chapter: false
77
---
88

9-
# Welcome the libp2p Documentation Portal
9+
# Welcome to the libp2p Book
10+
11+
{{% notice "note" %}}
12+
This section is incomplete, and many of the articles are stubs. To help fill in
13+
the gaps, please see the issues linked in each article to add your input and
14+
help us prioritize the outstanding work.
15+
{{% /notice %}}
1016

1117
### Chapter 1: Introduction
1218

19+
Get started with computer networking and science concepts, distributed systems, and
20+
how libp2p fits into the internet as we know it.
21+
1322
### Chapter 2: Core Components
1423

24+
Learn about the core components that make up a full libp2p network stack
25+
including network components,
26+
1527
### Chapter 3: Guides
1628

29+
Start interacting with libp2p, spawn a node, transmit data, and learn how to
30+
use libp2p protocols in your application.
31+
1732
### Chapter 4: Reference Documentation
1833

34+
Find all the available libp2p specifications and different types of reference documentation.
35+
1936
### Chapter 5: Get Involved
37+
38+
Learn how to get involved in the libp2p community.

‎content/concepts/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ chapter: true
1212
libp2p covers a lot of ground, and may involve unfamiliar terminology and concepts.
1313
This section goes over the foundational concepts involved in libp2p.
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/concepts/data-exchange/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Exchange Data
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/data-exchange/bitswap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Bitswap"
3-
weight: 8
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.8.1. </b>'
3+
weight: 2
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.8.2. </b>'
55
---
66

77
{{% notice "note" %}}

‎content/concepts/data-exchange/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
title: 'Overview'
33
weight: 1
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.9.1. </b>'
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.8.1. </b>'
55
---

‎content/concepts/discovery/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Discover Peers
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/introduction/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Key Components of libp2p
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/introduction/addressing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Addressing
3-
weight: 1
3+
weight: 2
44
pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.2. </b>'
55
---
66

‎content/concepts/introduction/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Overview"
3-
weight: 2
3+
weight: 1
44
pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.1 </b>'
55
---
66

‎content/concepts/introduction/protocols.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Protocols
3-
weight: 2
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.3. </b>'
3+
weight: 3
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.2. </b>'
55
---
66

77
There are protocols everywhere you look when you're writing network applications, and libp2p is

‎content/concepts/messaging/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Transmit Data
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/miscellaneous/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Learn more
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/multiplex/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Stream bytes
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/nat/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Traverse Bytes
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/nat/autonat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: AutoNAT
3-
weight: 3
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.3. </b>'
3+
weight: 4
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.4. </b>'
55
---
66

77
{{% notice "note" %}}

‎content/concepts/nat/dcutr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: DCUtR
3-
weight: 4
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.4. </b>'
3+
weight: 5
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.5. </b>'
55
---
66

77
{{% notice "note" %}}

‎content/concepts/nat/hole-punching.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Hole Punching
3-
weight: 2
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.5. </b>'
3+
weight: 3
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.3. </b>'
55
---
66

77
{{% notice "note" %}}

‎content/concepts/routing/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Route with Peers
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/secure-comm/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Secure bytes
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/security/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Secure Data
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/transports/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ chapter: true
99

1010
# Exchange Bytes
1111

12-
{{% children %}}
12+
{{% children description="true" %}}
1313

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

‎content/concepts/transports/webrtc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: WebRTC
3-
weight: 5
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.5. </b>'
3+
weight: 6
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.6. </b>'
55
---
66

77
{{% notice "note" %}}

‎content/concepts/transports/webtransport.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: WebTransport
3-
weight: 6
4-
pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.6. </b>'
3+
weight: 5
4+
pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.5. </b>'
55
---
66

77
{{% notice "note" %}}

‎content/get-involved/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 5
44
pre: "<b>5. </b>"
55
---
66

7-
{{% children %}}
7+
{{% children description="true" %}}
88

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

‎content/guides/get-started/install.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,3 @@ This section is incomplete, and many of the articles are stubs. To help fill in
2424
the gaps, please see the issues linked in each article to add your input and
2525
help us prioritize the outstanding work.
2626
{{% /notice %}}
27-

‎content/guides/protocol-basics/discovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Get Started with Discovery
33
menuTitle: Peer Discovery
4-
weight: 5
4+
weight: 6
55
pre: '<i class="fas fa-fw fa-book"></i> <b>3.2.6. </b>'
66
---
77

‎content/introduction/libp2p/_index.md

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

7-
### Chapter 1
8-
97
# Get Started with libp2p
108

119
Whether you’re just starting to dive into peer-to-peer concepts and

0 commit comments

Comments
 (0)