chore: add help section to all readmes

achingbrain · achingbrain · commit 564ef5111074 · 2024-09-23T09:36:14.000+01:00
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@
 - Read the [libp2p specs](https://github.com/libp2p/specs)
 - See https://blog.libp2p.io for news and more
 - Head over to https://proto.school to take interactive tutorials that cover core libp2p APIs
-- Need help? Please ask 'How do I?' questions on https://github.com/libp2p/js-libp2p/discussions
+- Need help? Visit the discussion board: https://github.com/libp2p/js-libp2p/discussions
 
 ## Getting Started
 
diff --git a/examples/js-libp2p-example-browser-pubsub/README.md b/examples/js-libp2p-example-browser-pubsub/README.md
@@ -16,6 +16,7 @@ This example leverages the [vite bundler](https://vitejs.dev/) to compile and se
   - [Why do I need a Relay Server?](#why-do-i-need-a-relay-server)
   - [Start the Relay Server](#start-the-relay-server)
   - [Running the Example](#running-the-example)
+- [Need help?](#need-help)
 - [License](#license)
 - [Contribution](#contribution)
 
@@ -89,6 +90,14 @@ You can now shut down the relay server if you wish.
 
 You should see the message appear in the output section towards the bottom of the other browser window.
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-chat/README.md b/examples/js-libp2p-example-chat/README.md
@@ -11,6 +11,7 @@
 
 - [Setup](#setup)
 - [Running](#running)
+- [Need help?](#need-help)
 - [License](#license)
 - [Contribution](#contribution)
 
@@ -30,6 +31,14 @@
 4. Type a message in either window and hit *enter*
 5. Tell yourself secrets to your hearts content!
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-circuit-relay/README.md b/examples/js-libp2p-example-circuit-relay/README.md
@@ -14,6 +14,7 @@
 - [2. Set up a listener node with `discoverRelays` Enabled](#2-set-up-a-listener-node-with-discoverrelays-enabled)
 - [3. Set up a dialer node for testing connectivity](#3-set-up-a-dialer-node-for-testing-connectivity)
 - [4. What is next?](#4-what-is-next)
+- [Need help?](#need-help)
 - [License](#license)
 - [Contribution](#contribution)
 
@@ -226,6 +227,14 @@ establish unencrypted connection from secure context. The simplest solution is
 to setup SSL with nginx and proxy to the node and setup a domain name for the
 certificate.
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-connection-encryption/README.md b/examples/js-libp2p-example-connection-encryption/README.md
@@ -10,6 +10,7 @@
 ## Table of contents <!-- omit in toc -->
 
 - [Set up encrypted communications](#set-up-encrypted-communications)
+- [Need help?](#need-help)
 - [License](#license)
 - [Contribution](#contribution)
 
@@ -55,6 +56,14 @@ And that's it, from now on, all your libp2p communications are encrypted. Try ru
 
 To experiment with the plaintext implementation, run [plaintext.js](./plaintext.js).
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-custom-protocols/README.md b/examples/js-libp2p-example-custom-protocols/README.md
@@ -16,6 +16,7 @@
     - [Message formatting](#message-formatting)
     - [Putting it together](#putting-it-together)
   - [Next steps](#next-steps)
+- [Need help?](#need-help)
 - [License](#license)
 - [Contribution](#contribution)
 
@@ -157,6 +158,14 @@ const output = JSON.parse(new TextDecoder().decode(res.subarray()))
 
 To send more structured data, you can use [protons](https://www.npmjs.com/package/protons) to create protobuf definitions of your messages and [it-protobuf-stream](https://www.npmjs.com/package/it-protobuf-stream) to send them back and forth.
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-delegated-routing/README.md b/examples/js-libp2p-example-delegated-routing/README.md
@@ -12,6 +12,7 @@
 - [Running this example](#running-this-example)
   - [Finding Content Providers via the Delegate](#finding-content-providers-via-the-delegate)
   - [Finding Peers via the Delegate](#finding-peers-via-the-delegate)
+- [Need help?](#need-help)
 - [License](#license)
 - [Contribution](#contribution)
 
@@ -48,6 +49,14 @@ This should open your browser to <http://localhost:3000>. If it does not, go ahe
 2. Click "Find PeerInfo"
 3. If found, multiaddrs for the peer will appear in the box beneath the input fields
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-discovery-mechanisms/README.md b/examples/js-libp2p-example-discovery-mechanisms/README.md
@@ -13,6 +13,7 @@
 - [2. Using MulticastDNS to find other peers on the same network](#2-using-multicastdns-to-find-other-peers-on-the-same-network)
 - [3. Pubsub based Peer Discovery](#3-pubsub-based-peer-discovery)
 - [4. Where to find other Peer Discovery Mechanisms](#4-where-to-find-other-peer-discovery-mechanisms)
+- [Need help?](#need-help)
 - [License](#license)
 - [Contribution](#contribution)
 
@@ -135,6 +136,14 @@ There are plenty more Peer Discovery Mechanisms out there, you can:
 - Any DHT will offer you a discovery capability. You can simple *random-walk* the routing tables to find other peers to connect to. For example [@libp2p/kad-dht](https://github.com/libp2p/js-libp2p/tree/master/packages/kad-dht) can be used for peer discovery. An example of how to configure it to enable random walks can be found [here](https://github.com/libp2p/js-libp2p/blob/v0.28.4/doc/CONFIGURATION.md#customizing-dht).
 - You can create your own Discovery service, a registry, a list, a radio beacon, you name it!
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-peer-and-content-routing/README.md b/examples/js-libp2p-example-peer-and-content-routing/README.md
@@ -112,6 +112,14 @@ Found provider: QmSsmVPoTy3WpzwiNPnsKmonBaZjK2HitFs2nWUvwK31Pz
 
 That's it, now you know how to find peers that have pieces of information that interest you!
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-pnet/README.md b/examples/js-libp2p-example-pnet/README.md
@@ -44,6 +44,14 @@ directory to see how they differ, including the swarm keys. You should see a
 `swarm.key` file in each of the repos and when the nodes are on the same private
 network this contents of the `swarm.key` files should be the same.
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-protocol-and-stream-muxing/README.md b/examples/js-libp2p-example-protocol-and-stream-muxing/README.md
@@ -327,6 +327,14 @@ await pipe(
 )
 ```
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-pubsub/README.md b/examples/js-libp2p-example-pubsub/README.md
@@ -170,6 +170,14 @@ node3 received: orange
 
 You can find the complete version at [2.js](./2.js).
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
diff --git a/examples/js-libp2p-example-transports/README.md b/examples/js-libp2p-example-transports/README.md
@@ -306,6 +306,14 @@ If you decide to implement a transport yourself, please consider adding to the l
 
 Hope this tutorial was useful. We are always looking to improve it, so contributions are welcome!
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
@@ -318,9 +326,6 @@ Licensed under either of
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
 [interface-transport]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport
-
 [interface-transport badge]: https://raw.githubusercontent.com/libp2p/js-libp2p-interfaces/master/packages/libp2p-interfaces/src/transport/img/badge.png
-
 [interface-transport implementations]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#modules-that-implement-the-interface
-
 [interface-transport api]: https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#api
diff --git a/examples/js-libp2p-example-webrtc-private-to-private/README.md b/examples/js-libp2p-example-webrtc-private-to-private/README.md
@@ -94,6 +94,14 @@ The WebRTC transport is not limited to browsers.
 
 Why don't you try to create a Node.js version of the [browser peer script](./index.js)?
 
+## Need help?
+
+- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
+- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
+- Check out the [general libp2p documentation](https://docs.libp2p.io) for tips, how-tos and more
+- Read the [libp2p specs](https://github.com/libp2p/specs)
+- Ask a question on the [js-libp2p discussion board](https://github.com/libp2p/js-libp2p/discussions)
+
 ## License
 
 Licensed under either of
