edits edits

libp2p · Sep 13, 2022 · c240fb3 · c240fb3
1 parent 3758724
commit c240fb3
Show file tree

Hide file tree

Showing 28 changed files with 53 additions and 37 deletions.
diff --git a/config.toml b/config.toml
@@ -3,7 +3,7 @@ relativeURLs = true
 languageCode = "en-us"
 title = "libp2p Documentation"
 
-theme = "hugo-theme-learn"
+theme = ["hugo-theme-learn"]
 
 [params]
 themeVariant = "libp2p"

diff --git a/content/_index.md b/content/_index.md
@@ -1,19 +1,38 @@
 ---
-title: Welcome to the libp2p documentation portal
+title: libp2p book
 menuTitle: libp2p
 weight: 1
 pre: "<b>1. </b>"
 chapter: false
 ---
 
-# Welcome the libp2p Documentation Portal
+# Welcome to the libp2p Book
+
+{{% 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 %}}
 
 ### Chapter 1: Introduction
 
+Get started with computer networking and science concepts, distributed systems, and
+how libp2p fits into the internet as we know it.
+
 ### Chapter 2: Core Components
 
+Learn about the core components that make up a full libp2p network stack
+including network components, 
+
 ### Chapter 3: Guides
 
+Start interacting with libp2p, spawn a node, transmit data, and learn how to
+use libp2p protocols in your application.
+
 ### Chapter 4: Reference Documentation
 
+Find all the available libp2p specifications and different types of reference documentation.
+
 ### Chapter 5: Get Involved
+
+Learn how to get involved in the libp2p community.
diff --git a/content/concepts/_index.md b/content/concepts/_index.md
@@ -12,7 +12,7 @@ chapter: true
 libp2p covers a lot of ground, and may involve unfamiliar terminology and concepts.
 This section goes over the foundational concepts involved in libp2p.
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/data-exchange/_index.md b/content/concepts/data-exchange/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Exchange Data
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/data-exchange/bitswap.md b/content/concepts/data-exchange/bitswap.md
@@ -1,7 +1,7 @@
 ---
 title: "Bitswap"
-weight: 8
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.8.1. </b>'
+weight: 2
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.8.2. </b>'
 ---
 
 {{% notice "note" %}}

diff --git a/content/concepts/data-exchange/overview.md b/content/concepts/data-exchange/overview.md
@@ -1,5 +1,5 @@
 ---
 title: 'Overview'
 weight: 1
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.9.1. </b>'
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.8.1. </b>'
 ---
diff --git a/content/concepts/discovery/_index.md b/content/concepts/discovery/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Discover Peers
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/introduction/_index.md b/content/concepts/introduction/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Key Components of libp2p
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/introduction/addressing.md b/content/concepts/introduction/addressing.md
@@ -1,6 +1,6 @@
 ---
 title: Addressing
-weight: 1
+weight: 2
 pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.2. </b>'
 ---
 

diff --git a/content/concepts/introduction/overview.md b/content/concepts/introduction/overview.md
@@ -1,6 +1,6 @@
 ---
 title: "Overview"
-weight: 2
+weight: 1
 pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.1 </b>'
 ---
 

diff --git a/content/concepts/introduction/protocols.md b/content/concepts/introduction/protocols.md
@@ -1,7 +1,7 @@
 ---
 title: Protocols
-weight: 2
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.3. </b>'
+weight: 3
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.0.2. </b>'
 ---
 
 There are protocols everywhere you look when you're writing network applications, and libp2p is

diff --git a/content/concepts/messaging/_index.md b/content/concepts/messaging/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Transmit Data
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/miscellaneous/_index.md b/content/concepts/miscellaneous/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Learn more
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/multiplex/_index.md b/content/concepts/multiplex/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Stream bytes
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/nat/_index.md b/content/concepts/nat/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Traverse Bytes
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/nat/autonat.md b/content/concepts/nat/autonat.md
@@ -1,7 +1,7 @@
 ---
 title: AutoNAT
-weight: 3
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.3. </b>'
+weight: 4
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.4. </b>'
 ---
 
 {{% notice "note" %}}

diff --git a/content/concepts/nat/dcutr.md b/content/concepts/nat/dcutr.md
@@ -1,7 +1,7 @@
 ---
 title: DCUtR
-weight: 4
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.4. </b>'
+weight: 5
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.5. </b>'
 ---
 
 {{% notice "note" %}}

diff --git a/content/concepts/nat/hole-punching.md b/content/concepts/nat/hole-punching.md
@@ -1,7 +1,7 @@
 ---
 title: Hole Punching
-weight: 2
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.5. </b>'
+weight: 3
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.4.3. </b>'
 ---
 
 {{% notice "note" %}}

diff --git a/content/concepts/routing/_index.md b/content/concepts/routing/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Route with Peers
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/secure-comm/_index.md b/content/concepts/secure-comm/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Secure bytes
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/security/_index.md b/content/concepts/security/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Secure Data
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/transports/_index.md b/content/concepts/transports/_index.md
@@ -9,7 +9,7 @@ chapter: true
 
 # Exchange Bytes
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/concepts/transports/webrtc.md b/content/concepts/transports/webrtc.md
@@ -1,7 +1,7 @@
 ---
 title: WebRTC
-weight: 5
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.5. </b>'
+weight: 6
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.6. </b>'
 ---
 
 {{% notice "note" %}}

diff --git a/content/concepts/transports/webtransport.md b/content/concepts/transports/webtransport.md
@@ -1,7 +1,7 @@
 ---
 title: WebTransport
-weight: 6
-pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.6. </b>'
+weight: 5
+pre: '<i class="fas fa-fw fa-book"></i> <b>2.1.5. </b>'
 ---
 
 {{% notice "note" %}}

diff --git a/content/get-involved/_index.md b/content/get-involved/_index.md
@@ -4,7 +4,7 @@ weight: 5
 pre: "<b>5. </b>"
 ---
 
-{{% children %}}
+{{% children description="true" %}}
 
 {{% notice "note" %}}
 This section is incomplete, and many of the articles are stubs. To help fill in

diff --git a/content/guides/get-started/install.md b/content/guides/get-started/install.md
@@ -24,4 +24,3 @@ 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 %}}
-
diff --git a/content/guides/protocol-basics/discovery.md b/content/guides/protocol-basics/discovery.md
@@ -1,7 +1,7 @@
 ---
 title: Get Started with Discovery
 menuTitle: Peer Discovery
-weight: 5
+weight: 6
 pre: '<i class="fas fa-fw fa-book"></i> <b>3.2.6. </b>'
 ---
 

diff --git a/content/introduction/libp2p/_index.md b/content/introduction/libp2p/_index.md
@@ -4,8 +4,6 @@ weight: 2
 pre: '<i class="fas fa-fw fa-book"></i> <b>1.2. </b>'
 ---
 
-### Chapter 1
-
 # Get Started with libp2p
 
 Whether you’re just starting to dive into peer-to-peer concepts and
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,3 @@ 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 %}}