From 531dac96b8919fa53704deff77b36ffc607c8e09 Mon Sep 17 00:00:00 2001 From: LordGhostX Date: Mon, 22 May 2023 13:35:34 +0100 Subject: [PATCH] add contribute page --- docs/contribute.md | 35 +++++++++++++++++++++++ docs/overview/concepts/peer-discovery.md | 2 +- docs/overview/reference/waku-vs-libp2p.md | 2 +- docs/powered-by-waku.mdx | 1 - docusaurus.config.js | 18 ++++++++++-- sidebars.js | 3 +- 6 files changed, 55 insertions(+), 6 deletions(-) create mode 100644 docs/contribute.md diff --git a/docs/contribute.md b/docs/contribute.md new file mode 100644 index 0000000..d864d75 --- /dev/null +++ b/docs/contribute.md @@ -0,0 +1,35 @@ +--- +title: Contribute to Waku +--- + +Get involved in Waku's open-source initiatives to improve the protocol, implementations, developer tools, and documentation. + +## Run a Node + +The Waku network is permissionless and decentralized, consisting of nodes. It is open for anyone to run their node, use the network, and contribute to its support. Please visit the [running a nwaku node](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md) guide to learn more. + +## Build a Waku Application + +By integrating Waku into your application, you can contribute by: + +- Running a Waku node within your application. +- Reporting bugs and suggesting missing features to the development team. +- Inspiring other developers to explore and utilize Waku for [various use cases](/overview/use-cases). + +Begin your journey by exploring [Waku's diverse platforms](/platform/overview) and start building today! + +## Report a Bug + +To report a bug, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the bug and include detailed steps to reproduce the bug. + +## Request for a Feature + +To request a new feature, create an issue in the appropriate [GitHub repository](https://github.com/waku-org). Ensure no issue exists about the feature and specify the use cases the feature can enable, allowing us to investigate and prioritize accordingly. + +## Make a Pull Request + +Community pull requests (PRs) are highly encouraged, but we recommend beginning with a feature request or posting on the [Vac Discourse forum](https://forum.vac.dev/) to gauge interest and gather feedback before proceeding with a PR. + +## Contribute to Waku Research + +[Vac](https://vac.dev/) drives Waku research, advancing through ongoing R&D. Vac is dedicated to developing modular p2p protocols for private, secure, and censorship-resistant communication. Explore Vac's open problems at . \ No newline at end of file diff --git a/docs/overview/concepts/peer-discovery.md b/docs/overview/concepts/peer-discovery.md index cb65337..920681b 100644 --- a/docs/overview/concepts/peer-discovery.md +++ b/docs/overview/concepts/peer-discovery.md @@ -12,7 +12,7 @@ Once a connection is established, the node must actively seek out additional pee ## Predefined Nodes -Waku applications have the flexibility to embed bootstrap node addresses directly into their codebase. Developers can opt to utilize either the [predefined nodes by Status](https://github.com/waku-org/js-waku/blob/master/packages/core/src/lib/predefined_bootstrap_nodes.ts#L45) or [set up their nodes](https://github.com/waku-org/nwaku/tree/master/docs/operators) per their preference. +Waku applications have the flexibility to embed bootstrap node addresses directly into their codebase. Developers can opt to utilize either the [predefined nodes by Status](https://github.com/waku-org/js-waku/blob/master/packages/core/src/lib/predefined_bootstrap_nodes.ts#L45) or [set up their nodes](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md) per their preference. #### Pros diff --git a/docs/overview/reference/waku-vs-libp2p.md b/docs/overview/reference/waku-vs-libp2p.md index c2b6179..e179560 100644 --- a/docs/overview/reference/waku-vs-libp2p.md +++ b/docs/overview/reference/waku-vs-libp2p.md @@ -6,7 +6,7 @@ Since Waku is built on top of libp2p, they share a lot of concepts and terminolo ## Waku as a Service Network -Waku intends to incentivize mechanisms to run nodes, but it's not part of libp2p's scope. Additionally, users or developers do not have to deploy their infra as a prerequisite to use Waku. It is a service network. However, you are encouraged to [run your node](https://github.com/waku-org/nwaku/tree/master/docs/operators) to support and decentralize the network. +Waku intends to incentivize mechanisms to run nodes, but it's not part of libp2p's scope. Additionally, users or developers do not have to deploy their infra as a prerequisite to use Waku. It is a service network. However, you are encouraged to [run your node](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md) to support and decentralize the network. ## Waku as a Keyturn Solution diff --git a/docs/powered-by-waku.mdx b/docs/powered-by-waku.mdx index 04f23a1..155cedf 100644 --- a/docs/powered-by-waku.mdx +++ b/docs/powered-by-waku.mdx @@ -1,7 +1,6 @@ --- title: Powered by Waku custom_edit_url: null -hide_table_of_contents: true --- Leap into the future with Waku! Revolutionize communication, collaboration, and connectivity. Join us and create something extraordinary! diff --git a/docusaurus.config.js b/docusaurus.config.js index a8e550c..4b43b4b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -78,9 +78,23 @@ const config = { position: "right" }, { - to: "/community", + type: "dropdown", label: "Community", - position: "right" + position: "right", + items: [ + { + label: "Join Our Community", + to: "/community" + }, + { + label: "Contribute to Waku", + to: "/contribute" + }, + { + label: "Open Bounties", + href: "https://bounties.gitcoin.co/status-im/bounties" + } + ] }, { href: "https://github.com/waku-org", diff --git a/sidebars.js b/sidebars.js index 4ee89e6..cc2d109 100644 --- a/sidebars.js +++ b/sidebars.js @@ -38,7 +38,8 @@ const sidebars = { ], community: [ "powered-by-waku", - "community" + "community", + "contribute" ] };