diff --git a/content/get-involved/_index.md b/content/get-involved/_index.md index b8c71ee8..a91cfd1d 100644 --- a/content/get-involved/_index.md +++ b/content/get-involved/_index.md @@ -2,8 +2,13 @@ title: "Get Involved" weight: 5 pre: "5. " +chapter: true --- +### Chapter 5 + +# Get Involved + {{% children description="true" %}} {{% notice "note" %}} diff --git a/content/guides/_index.md b/content/guides/_index.md index 17325ef1..a57bb2de 100644 --- a/content/guides/_index.md +++ b/content/guides/_index.md @@ -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 diff --git a/content/guides/examples/_index.md b/content/guides/examples/_index.md index d893604f..a4c67503 100644 --- a/content/guides/examples/_index.md +++ b/content/guides/examples/_index.md @@ -6,6 +6,8 @@ pre: ' 3.3. ' 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 diff --git a/content/guides/protocol-basics/_index.md b/content/guides/protocol-basics/_index.md index ea58a2b8..2b02a3e5 100644 --- a/content/guides/protocol-basics/_index.md +++ b/content/guides/protocol-basics/_index.md @@ -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 diff --git a/content/introduction/_index.md b/content/introduction/_index.md index 876c1e15..9125918a 100644 --- a/content/introduction/_index.md +++ b/content/introduction/_index.md @@ -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. diff --git a/content/reference/_index.md b/content/reference/_index.md index 2118067b..ed2548d1 100644 --- a/content/reference/_index.md +++ b/content/reference/_index.md @@ -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 %}} diff --git a/content/reference/overview.md b/content/reference/overview.md index 757cec3e..d295e0e1 100644 --- a/content/reference/overview.md +++ b/content/reference/overview.md @@ -4,6 +4,29 @@ weight: 1 pre: ' 4.1. ' --- +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