add contribute page

This commit is contained in:
LordGhostX 2023-05-22 13:35:34 +01:00
parent a3d192b14e
commit 531dac96b8
No known key found for this signature in database
GPG Key ID: 520CC5DC4F94FCC7
6 changed files with 55 additions and 6 deletions

35
docs/contribute.md Normal file
View File

@ -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 <https://vac.dev/open-problems>.

View File

@ -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

View File

@ -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

View File

@ -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!

View File

@ -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",

View File

@ -38,7 +38,8 @@ const sidebars = {
],
community: [
"powered-by-waku",
"community"
"community",
"contribute"
]
};