diff --git a/docs/contribute.md b/docs/contribute.md index 2cba857..bc9263b 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -4,11 +4,11 @@ title: Contribute to Waku Get involved in Waku's open-source initiatives to improve the protocols, SDKs, developer tools and examples, and documentation. You can contribute by: -- [Operating a node](/guides/sdks-and-nodes#operate-a-waku-node) within your application. +- [Operating a node](/guides/nodes-and-sdks#operate-a-waku-node) within your application. - [Reporting bugs](#report-a-bug) and [suggesting missing features](#suggest-a-feature) to the development team. - Inspiring other developers to explore and use Waku for [various use cases](/overview/use-cases). -Begin your journey by visiting the [SDKs and Nodes](/guides/sdks-and-nodes) guide and start building on Waku today! +Begin your journey by visiting the [Nodes and SDKs](/guides/nodes-and-sdks) guide and start building on Waku today! ## Report a Bug diff --git a/docs/guides/sdks-and-nodes.md b/docs/guides/nodes-and-sdks.md similarity index 75% rename from docs/guides/sdks-and-nodes.md rename to docs/guides/nodes-and-sdks.md index b226caa..644863c 100644 --- a/docs/guides/sdks-and-nodes.md +++ b/docs/guides/nodes-and-sdks.md @@ -1,5 +1,5 @@ --- -title: SDKs and Nodes +title: Nodes and SDKs --- :::caution @@ -10,7 +10,12 @@ Ready to integrate Waku into your application for private, secure, censorship-fr ## Operate a Waku Node -The Waku Network is permissionless and decentralized, consisting of nodes. It is open for anyone to run a node, use the network, and contribute to its support. Please visit the [nwaku guide](https://github.com/waku-org/nwaku/tree/master/docs/operators) (recommended) or [go-waku guide](https://github.com/waku-org/go-waku/tree/master/docs/operators) for operators to learn more. +The Waku Network is a decentralized, permissionless system where anyone can run nodes, use the network, and contribute to its support. + +| Client | Description | Documentation | +| - | - | - | +| [nwaku](https://github.com/waku-org/nwaku) | Nim-based Waku implementation to run a standalone node and access the network (recommended) | [Run Nwaku Node](/guides/run-nwaku-node) | +| [go-waku](https://github.com/waku-org/go-waku) | Golang-based Waku implementation to run a standalone node and access the network | [Run Go-Waku Node](https://github.com/waku-org/go-waku/tree/master/docs/operators) | ## Integrate Using SDKs @@ -19,7 +24,7 @@ Waku is implemented in multiple SDKs, allowing it to easily integrate with diffe | SDK | Description | Documentation | | - | - | - | | [js-waku](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | | -| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK for running a standalone node and accessing the Waku Network | | +| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK designed for integration with native Nim applications | | | [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration with Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | | | [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using `go-waku` bindings designed for integration in Rust applications | | diff --git a/docs/guides/run-nwaku-node.md b/docs/guides/run-nwaku-node.md new file mode 100644 index 0000000..967bb08 --- /dev/null +++ b/docs/guides/run-nwaku-node.md @@ -0,0 +1,17 @@ +--- +title: Run Nwaku Node +--- + +Nwaku (formerly `nim-waku`) is a lightweight and robust Nim client for running a Waku node, equipped with tools to monitor and maintain a running node. Nwaku is highly configurable, enabling operators to select the [protocols](/overview/concepts/protocols) they wish to support based on their needs, motivations, and available resources. + +This guide provides detailed steps to build, configure, and connect a `nwaku` node to the Waku Network. It also covers using existing tools to monitor and maintain the node. + +## Build the Node + +## Configure the Node + +## Connect the Node + +## Interact with the Node + +## Monitor the Node \ No newline at end of file diff --git a/docs/overview/concepts/peer-discovery.md b/docs/overview/concepts/peer-discovery.md index d084407..47ed50c 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 use 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 [operate a node](/guides/sdks-and-nodes#operate-a-waku-node) per their preference. +Waku applications have the flexibility to embed bootstrap node addresses directly into their codebase. Developers can opt to use 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 [operate a node](/guides/nodes-and-sdks#operate-a-waku-node) per their preference. #### Pros diff --git a/docs/overview/reference/glossary.md b/docs/overview/reference/glossary.md index 7c6281d..aaad140 100644 --- a/docs/overview/reference/glossary.md +++ b/docs/overview/reference/glossary.md @@ -98,7 +98,7 @@ Resource-limited refers to environments or devices restricting available resourc RLN Relay is an extension of the [Relay protocol](#relay) that uses [Rate Limit Nullifiers (RLN)](#rate-limit-nullifiers) to prevent spam economically by enforcing a rate limit on messages over time, imposing penalties, and facilitating network removal for spammers. -### [SDK](/guides/sdks-and-nodes) +### [SDK](/guides/nodes-and-sdks) SDKs are tools, libraries, and resources to integrate Waku's private, secure, and censorship-free communication features into various applications. diff --git a/docs/overview/reference/waku-vs-libp2p.md b/docs/overview/reference/waku-vs-libp2p.md index 7d9735e..7327d29 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 [operate a node](/guides/sdks-and-nodes#operate-a-waku-node) 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 [operate a node](/guides/nodes-and-sdks#operate-a-waku-node) to support and decentralize the network. ## Waku as a Keyturn Solution diff --git a/docs/presentations.md b/docs/presentations.md index 5b3cff6..52af9f6 100644 --- a/docs/presentations.md +++ b/docs/presentations.md @@ -2,7 +2,7 @@ title: Watch Our Presentations --- -## Using ZKP for Better p2p Messaging With Waku +## Using ZKP for Better p2p Messaging with Waku diff --git a/docusaurus.config.js b/docusaurus.config.js index e4f1f76..6033967 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -63,8 +63,12 @@ const config = { position: "right", items: [ { - label: "SDKs and Nodes", - to: "/guides/sdks-and-nodes" + label: "Nodes and SDKs", + to: "/guides/nodes-and-sdks" + }, + { + label: "Run Nwaku Node", + to: "guides/run-nwaku-node" } ] }, @@ -110,8 +114,12 @@ const config = { title: "Guides", items: [ { - to: "/guides/sdks-and-nodes", - label: "SDKs and Nodes" + to: "/guides/nodes-and-sdks", + label: "Nodes and SDKs" + }, + { + label: "Run Nwaku Node", + to: "guides/run-nwaku-node" } ] }, diff --git a/sidebars.js b/sidebars.js index d07d7ca..b17d39c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -14,7 +14,7 @@ const sidebars = { "overview/use-cases", { type: "html", - value: "SDKs and Nodes " + value: "Nodes and SDKs " }, { type: "html", @@ -51,7 +51,8 @@ const sidebars = { label: "Guides", collapsible: false, items: [ - "guides/sdks-and-nodes" + "guides/nodes-and-sdks", + "guides/run-nwaku-node" ] } ],