diff --git a/README.md b/README.md index 9fce9d7..02c548f 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ git clone https://github.com/waku-org/waku.guide Install the dependencies: ```bash +yarn + +# or + yarn install ``` diff --git a/docs/clients/js-waku/build-chat-app.mdx b/docs/clients/js-waku/build-chat-app.mdx index c85977f..464e988 100644 --- a/docs/clients/js-waku/build-chat-app.mdx +++ b/docs/clients/js-waku/build-chat-app.mdx @@ -121,7 +121,7 @@ await waku.waitForRemotePeer(wakuNode) The `contentTopic` is a metadata `string` used for categorizing messages on the Waku network. Depending on your use case, you can create one or more new `contentTopic`(s). -Refer to our [How to Choose a Content Topic](/overview/concepts/content-topics) guide more details. +Refer to our [How to Choose a Content Topic](/) guide more details. For this guide, we'll use `/chat-app-guide/1/message/utf8`. Note that our payload will be encoded using `utf-8`. diff --git a/docs/clients/js-waku/quick-start.mdx b/docs/clients/js-waku/quick-start.mdx index 06ff46f..23836b9 100644 --- a/docs/clients/js-waku/quick-start.mdx +++ b/docs/clients/js-waku/quick-start.mdx @@ -49,7 +49,7 @@ await waku.waitForRemotePeer(wakuNode) The `contentTopic` is a metadata `string` used for categorizing messages on the Waku network. Depending on your use case, you can create one or more new `contentTopic`(s). -Refer to our [How to Choose a Content Topic](/overview/concepts/content-topics) guide more details. +Refer to our [How to Choose a Content Topic](/) guide more details. For this guide, we'll use `/quick-start/1/message/utf8`. Note that our payload will be encoded using `utf-8`. diff --git a/docs/community.md b/docs/community.md index 3c70352..37ba2bb 100644 --- a/docs/community.md +++ b/docs/community.md @@ -4,13 +4,9 @@ title: Join Our Community Welcome to the Waku Community! Whether you're interested in building with Waku, contributing to the network, expanding your knowledge, or staying up-to-date with our progress, we have something for everyone. -## [Vac Forum](https://forum.vac.dev/) +## [Discord](https://discord.waku.org/) -Have you got questions, or are you eager to discuss Waku? Head to the [Vac Forum](https://forum.vac.dev/) and join the conversation! - -## [Discord](https://discord.gg/Nrac59MfSX) - -Connect with like-minded individuals in the Waku ecosystem! Introduce yourself, join developer conversations, or seek assistance. Join the [Waku Discord](https://discord.gg/Nrac59MfSX) today! +Connect with like-minded individuals in the Waku ecosystem! Introduce yourself, join developer conversations, or seek assistance. Join the [Waku Discord](https://discord.waku.org/) today! ## [Twitter](https://twitter.com/waku_org) @@ -18,4 +14,8 @@ Stay informed and updated with the latest news and insights from Waku. [Follow u ## [Telegram](https://t.me/waku_org) -Join the [Waku Telegram Group](https://t.me/waku_org) now and become part of the thriving community! Stay informed, share ideas, and connect with fellow enthusiasts. \ No newline at end of file +Join the [Waku Telegram Group](https://t.me/waku_org) now and become part of the thriving community! Stay informed, share ideas, and connect with fellow enthusiasts. + +## [Vac Forum](https://forum.vac.dev/) + +Have you got questions, or are you eager to discuss Waku? Head to the [Vac Forum](https://forum.vac.dev/) and join the conversation! \ No newline at end of file diff --git a/docs/contribute.md b/docs/contribute.md index 023e2b8..01cc3f4 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -2,17 +2,17 @@ title: Contribute to Waku --- -Get involved in Waku's open-source initiatives to improve the protocol, SDKs, developer tools, and documentation. +Get involved in Waku's open-source initiatives to improve the protocols, SDKs, developer tools and examples, and documentation. ## Build a Waku Application By integrating Waku into your application, you can contribute by: -- [Running a node](https://github.com/waku-org/nwaku/tree/master/docs/operators) within your application. +- [Operating a node](/guides/sdks-and-nodes#operate-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). +- Inspiring other developers to explore and utilize Waku for [various use cases](/getting-started/use-cases). -Begin your journey by exploring the [Waku platforms](/platform/overview) and start building today! +Begin your journey by visiting the [SDKs and Nodes](/guides/sdks-and-nodes) guide and start building today! ## Report a Bug @@ -24,7 +24,7 @@ To request a new feature, create an issue in the appropriate [GitHub repository] ## Make Pull Requests -Community pull requests (PRs) are highly encouraged, but we recommend beginning with a feature request or posting on the [Vac Forum](https://forum.vac.dev/) to gauge interest and gather feedback before proceeding with a PR. +Community pull requests (PRs) are highly encouraged, but we recommend beginning with a feature request or posting on the [Waku Discord](https://discord.waku.org/) to gauge interest and gather feedback before proceeding with a PR. ## Contribute to Waku Research diff --git a/docs/overview/concepts/content-topics.md b/docs/getting-started/concepts/content-topics.md similarity index 78% rename from docs/overview/concepts/content-topics.md rename to docs/getting-started/concepts/content-topics.md index 2bb1c01..10de916 100644 --- a/docs/overview/concepts/content-topics.md +++ b/docs/getting-started/concepts/content-topics.md @@ -2,7 +2,7 @@ title: Content Topics --- -`Content Topics` are metadata strings set by developers on outgoing messages to facilitate protocol-level features like selectively processing incoming messages ([Relay](/overview/concepts/protocols#relay) or [Filter](/overview/concepts/protocols#filter)) and retrieving historical messages ([Store](/overview/concepts/protocols#store)) that meet specific filtering criteria. Please refer to the [WAKU2-TOPICS](https://rfc.vac.dev/spec/23/#content-topics) specification to learn more. +`Content Topics` are metadata strings set by developers on outgoing messages to facilitate protocol-level features like selectively processing incoming messages ([Relay](/getting-started/concepts/protocols#relay) or [Filter](/getting-started/concepts/protocols#filter)) and retrieving historical messages ([Store](/getting-started/concepts/protocols#store)) that meet specific filtering criteria. Please refer to the [WAKU2-TOPICS](https://rfc.vac.dev/spec/23/#content-topics) specification to learn more. ## Content Topic Format diff --git a/docs/overview/concepts/network-domains.md b/docs/getting-started/concepts/network-domains.md similarity index 69% rename from docs/overview/concepts/network-domains.md rename to docs/getting-started/concepts/network-domains.md index c7ff59e..acea4b2 100644 --- a/docs/overview/concepts/network-domains.md +++ b/docs/getting-started/concepts/network-domains.md @@ -6,21 +6,21 @@ Waku is a unified and cohesive entity that offers a rich ecosystem with three di ## Discovery Domain -Peer discovery in Waku facilitates locating other peers within the network. As a modular protocol, Waku incorporates various discovery mechanisms, such as [Discv5](/overview/concepts/peer-discovery#discv5) and [Peer Exchange](/overview/concepts/peer-discovery#peer-exchange). These mechanisms allow developers to choose the most suitable option(s) for their specific use cases and user environments, including mobile phones, desktop browsers, servers, and more. +Peer discovery in Waku facilitates locating other peers within the network. As a modular protocol, Waku incorporates various discovery mechanisms, such as [Discv5](/getting-started/concepts/peer-discovery#discv5) and [Peer Exchange](/getting-started/concepts/peer-discovery#peer-exchange). These mechanisms allow developers to choose the most suitable option(s) for their specific use cases and user environments, including mobile phones, desktop browsers, servers, and more. ## Gossip Domain Gossipsub derives its name from the practice within Pub/Sub networks where peers gossip about the messages they have encountered, thus establishing a message delivery network. -Waku employs gossiping through [Relay](/overview/concepts/protocols#relay) to distribute messages across the network. Additionally, Waku introduces [RLN Relay](/overview/concepts/protocols#rln-relay), an experimental mechanism that combines privacy preservation and economic spam protection. +Waku employs gossiping through [Relay](/getting-started/concepts/protocols#relay) to distribute messages across the network. Additionally, Waku introduces [RLN Relay](/getting-started/concepts/protocols#rln-relay), an experimental mechanism that combines privacy preservation and economic spam protection. ## Request/Reply Domain Waku provides a set of protocols to optimize its performance in resource-limited environments like low bandwidth or offline scenarios for multiple purposes. -- [Store](/overview/concepts/protocols#store) enables the retrieval of historical messages. -- [Filter](/overview/concepts/protocols#filter) efficiently retrieves a subset of messages to conserve bandwidth. -- [Light Push](/overview/concepts/protocols#light-push) facilitates message publication for nodes with limited bandwidth and short connection windows. +- [Store](/getting-started/concepts/protocols#store) enables the retrieval of historical messages. +- [Filter](/getting-started/concepts/protocols#filter) efficiently retrieves a subset of messages to conserve bandwidth. +- [Light Push](/getting-started/concepts/protocols#light-push) facilitates message publication for nodes with limited bandwidth and short connection windows. ## Overview of Protocol Interaction @@ -50,7 +50,7 @@ D ->> E: HistoryResponse(msg1, ...) (6) The Pub/Sub topic `pubtopic1` serves as a means of routing messages (the network employs a default pubsub topic) and indicates that it is subscribed to messages on that topic for a relay. Node D serves as a `Store` and is responsible for persisting messages. -1. Node A creates a WakuMessage `msg1` with a [ContentTopic](/overview/concepts/content-topics) `contentTopic1`. +1. Node A creates a WakuMessage `msg1` with a [ContentTopic](/getting-started/concepts/content-topics) `contentTopic1`. 2. Node F requests to get messages filtered by Pub/Sub topic `pubtopic1` and ContentTopic `contentTopic1`. Node D subscribes F to this filter and will forward messages that match that filter in the future. 3. Node A publishes `msg1` on `pubtopic1`. The message is sent from Node A to Node B and then forwarded to Node D. 4. Node D, upon receiving `msg1` both stores the message for future retrieval by other nodes and forwards it to Node C. diff --git a/docs/overview/concepts/peer-discovery.md b/docs/getting-started/concepts/peer-discovery.md similarity index 85% rename from docs/overview/concepts/peer-discovery.md rename to docs/getting-started/concepts/peer-discovery.md index 83f4321..cc51234 100644 --- a/docs/overview/concepts/peer-discovery.md +++ b/docs/getting-started/concepts/peer-discovery.md @@ -6,13 +6,13 @@ When initializing a Waku node, it must connect with other peers to enable messag Once a connection is established, the node must actively seek out additional peers to have: -- Sufficient peers in the [Relay](/overview/concepts/protocols#relay) mesh: The goal is to have at least 6 peers in the mesh. This ensures a robust network where messages can be efficiently relayed. +- Sufficient peers in the [Relay](/getting-started/concepts/protocols#relay) mesh: The goal is to have at least 6 peers in the mesh. This ensures a robust network where messages can be efficiently relayed. - Reserve peers for backup: It is essential to have a surplus of peers available as reserves. These reserves are backups when the current peers become overloaded or experience unexpected disconnections. -- Peers with specific capabilities: The node seeks out peers with specific capabilities, such as [Store](/overview/concepts/protocols#store), [Light Push](/overview/concepts/protocols#light-push), or [Filter](/overview/concepts/protocols#filter). This allows for targeted interactions and enhanced functionality based on the desired capabilities. +- Peers with specific capabilities: The node seeks out peers with specific capabilities, such as [Store](/getting-started/concepts/protocols#store), [Light Push](/getting-started/concepts/protocols#light-push), or [Filter](/getting-started/concepts/protocols#filter). This allows for targeted interactions and enhanced functionality based on the desired capabilities. ## 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 [operate a node](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 [operate a node](/guides/sdks-and-nodes#operate-a-waku-node) per their preference. #### Pros diff --git a/docs/overview/concepts/protocols.md b/docs/getting-started/concepts/protocols.md similarity index 78% rename from docs/overview/concepts/protocols.md rename to docs/getting-started/concepts/protocols.md index a887b1f..9b5ba55 100644 --- a/docs/overview/concepts/protocols.md +++ b/docs/getting-started/concepts/protocols.md @@ -10,7 +10,7 @@ Waku takes a modular approach, providing a range of protocols that enable applic ## [RLN Relay](https://rfc.vac.dev/spec/17/) -`RLN Relay` protocol extends the `Relay` protocol by using [Rate Limit Nullifiers (RLN)](https://rfc.vac.dev/spec/32/) to provide efficient and economic spam prevention. It caps the bandwidth usage for all peers on the network, effectively preventing spam, and imposes financial penalties and network removal for spammers. You can find more details [in this blog post](https://vac.dev/rln-relay). +`RLN Relay` protocol extends the `Relay` protocol by using [Rate Limit Nullifiers (RLN)](https://rfc.vac.dev/spec/32/) to provide efficient and economic spam prevention. It caps the bandwidth usage for all peers on the network, effectively preventing spam, and imposes financial penalties and network removal for spammers. You can find more details in the [RLN Relay blog post](https://vac.dev/rln-relay). ## [Filter](https://rfc.vac.dev/spec/12/) @@ -26,7 +26,7 @@ Using `Relay` and `Filter` protocols is recommended when a node is online, as `S ## [Light Push](https://rfc.vac.dev/spec/19/) -`Light Push` is a [Request/Reply](/overview/concepts/network-domains#requestreply-domain) protocol for nodes with limited bandwidth and short connection windows. It allows a client to receive an acknowledgment when sending messages, indicating that at least one peer has received them. +`Light Push` is a [Request/Reply](/getting-started/concepts/network-domains#requestreply-domain) protocol for nodes with limited bandwidth and short connection windows. It allows a client to receive an acknowledgment when sending messages, indicating that at least one peer has received them. :::info While the `Light Push` protocol acknowledges the receipt by the remote peer, it does not guarantee network-wide propagation. @@ -36,12 +36,8 @@ While the `Light Push` protocol acknowledges the receipt by the remote peer, it `Waku Message` specifies the message structure used in the Waku network. It defines the attributes and metadata fields that accompany a message, including the following: -- `content_topic` attribute for [content-based filtering](/overview/concepts/content-topics). +- `content_topic` attribute for [content-based filtering](/getting-started/concepts/content-topics). - `payload` attribute containing the message data payload to be sent. - `meta` attribute for conveying additional details to various protocols for application-specific processing. - `timestamp` attribute signifying the time at which the message was generated by its sender. -- `ephemeral` attribute specifying whether the network should not persist the message. - -## [Payload](https://rfc.vac.dev/spec/26) - -`Payload` provides guidelines for implementing secure and private communication in the network. It covers encryption, decryption, and signing methods for message payloads, focusing on confidentiality, authenticity, integrity, and unlinkability. \ No newline at end of file +- `ephemeral` attribute specifying whether the network should not persist the message. \ No newline at end of file diff --git a/docs/overview/concepts/transports.md b/docs/getting-started/concepts/transports.md similarity index 100% rename from docs/overview/concepts/transports.md rename to docs/getting-started/concepts/transports.md diff --git a/docs/overview/history.md b/docs/getting-started/history.md similarity index 100% rename from docs/overview/history.md rename to docs/getting-started/history.md diff --git a/docs/overview/index.md b/docs/getting-started/index.md similarity index 82% rename from docs/overview/index.md rename to docs/getting-started/index.md index 216a243..584966b 100644 --- a/docs/overview/index.md +++ b/docs/getting-started/index.md @@ -9,7 +9,7 @@ Waku has risks and limitations as it is still developing and preparing for exten Waku, the standard of Web3 communication, is a family of protocols that offer secure, private, and peer-to-peer communication in a decentralized environment. It is designed to operate in resource-limited environments but can also be used as a node or desktop application. -Waku protocols ensure that users communication remains censorship-resistant and privacy-preserving, giving them complete control over their data. By incorporating Waku into your dApp, you can add decentralized communication features to your application without compromising security or privacy. +Waku protocols ensure that users communication remains censorship-resistant and privacy-preserving, giving them complete control over their data. By integrating Waku into your dApp, you can add decentralized communication features to your application without compromising security or privacy. ## Motivation and Goals @@ -37,7 +37,7 @@ Waku can cater to applications that require privacy guarantees, such as: - Pseudonymity and not being tied to any Personally Identifiable Information (PII). - Metadata protection in transit. -- Various forms of [unlinkability](/overview/reference/security-features#anonymityunlinkability). +- Various forms of [unlinkability](/getting-started/reference/security-features#anonymityunlinkability). ### Modular Design @@ -51,7 +51,7 @@ These options are part of the [Anonymity Trilemma](https://eprint.iacr.org/2017/ ## How Does Waku Work? -The [Relay](/overview/concepts/protocols#relay) protocol is the foundation of the Waku network, which employs a Pub/Sub architecture built on the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). Additionally, various other Waku protocols have been created to facilitate specific functionalities, including but not limited to: +The [Relay](/getting-started/concepts/protocols#relay) protocol is the foundation of the Waku network, which employs a Pub/Sub architecture built on the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md). Additionally, various other Waku protocols have been created to facilitate specific functionalities, including but not limited to: 1. Facilitating the retrieval of historical messages for primarily offline devices. 2. Providing solutions for encrypted communication, such as symmetric encryption, ECIES/asymmetric encryption, and noise handshake-based key turns. diff --git a/docs/overview/reference/glossary.md b/docs/getting-started/reference/glossary.md similarity index 100% rename from docs/overview/reference/glossary.md rename to docs/getting-started/reference/glossary.md diff --git a/docs/overview/reference/research-in-progress.md b/docs/getting-started/reference/research-in-progress.md similarity index 95% rename from docs/overview/reference/research-in-progress.md rename to docs/getting-started/reference/research-in-progress.md index 712a21d..8b23ad5 100644 --- a/docs/overview/reference/research-in-progress.md +++ b/docs/getting-started/reference/research-in-progress.md @@ -6,7 +6,7 @@ The following features are currently experimental and under research and initial ## Economic Spam Resistance -We aim to enable an incentivized spam protection technique to enhance `Relay` by using [Rate Limit Nullifiers (RLN)](https://rfc.vac.dev/spec/32/). In this advanced method, peers are limited to a certain messaging rate per epoch, and an immediate financial penalty is enforced for spammers who break this rate. You can find more details [in this blog post](https://vac.dev/rln-relay). +We aim to enable an incentivized spam protection technique to enhance `Relay` by using [Rate Limit Nullifiers (RLN)](https://rfc.vac.dev/spec/32/). In this advanced method, peers are limited to a certain messaging rate per epoch, and an immediate financial penalty is enforced for spammers who break this rate. You can find more details in the [RLN Relay blog post](https://vac.dev/rln-relay). We have prepared a PoC implementation of this method in JS: diff --git a/docs/overview/reference/security-features.md b/docs/getting-started/reference/security-features.md similarity index 95% rename from docs/overview/reference/security-features.md rename to docs/getting-started/reference/security-features.md index d899144..d218eff 100644 --- a/docs/overview/reference/security-features.md +++ b/docs/getting-started/reference/security-features.md @@ -21,7 +21,7 @@ Anonymity means an adversary cannot connect an actor to their actions or data. T The spam protection feature in `Relay` ensures that no adversary can flood the system with many messages, intentionally or not, regardless of the content's validity or usefulness. This protection is achieved through the [scoring mechanism](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#spam-protection-measures) of `GossipSub v1.1`. Peers assign scores to their connections based on their behavior and remove peers with low scores. -Ongoing research is being conducted, including developing [Rate Limit Nullifiers (RLN)](/overview/concepts/protocols#rln-relay), which can be explored further at: . +Ongoing research is being conducted, including developing [Rate Limit Nullifiers (RLN)](/getting-started/concepts/protocols#rln-relay), which can be explored further at: . ## [Data Confidentiality, Integrity, and Authenticity](https://rfc.vac.dev/spec/10/#data-confidentiality-integrity-and-authenticity) diff --git a/docs/overview/reference/waku-vs-libp2p.md b/docs/getting-started/reference/waku-vs-libp2p.md similarity index 66% rename from docs/overview/reference/waku-vs-libp2p.md rename to docs/getting-started/reference/waku-vs-libp2p.md index 1aec1e7..cede5a9 100644 --- a/docs/overview/reference/waku-vs-libp2p.md +++ b/docs/getting-started/reference/waku-vs-libp2p.md @@ -6,14 +6,14 @@ 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](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 [operate a node](/guides/sdks-and-nodes#operate-a-waku-node) to support and decentralize the network. ## Waku as a Keyturn Solution Waku includes various protocols covering the following domains: privacy preservation, censorship resistance, and platform agnosticism, allowing it to run on any platform or environment. -libp2p does not provide out-of-the-box protocols to enable mostly offline/resource-limited devices, [Store](/overview/concepts/protocols#store)/[Light Push](/overview/concepts/protocols#light-push)/[Filter](/overview/concepts/protocols#filter) caters to those use cases. +libp2p does not provide out-of-the-box protocols to enable mostly offline/resource-limited devices, [Store](/getting-started/concepts/protocols#store)/[Light Push](/getting-started/concepts/protocols#light-push)/[Filter](/getting-started/concepts/protocols#filter) caters to those use cases. ## Economic Spam Protection -libp2p does not have strong spam protection guarantees, [RLN Relay](/overview/concepts/protocols#rln-relay) is a protocol being developed by the Waku team towards this goal. +libp2p does not have strong spam protection guarantees, [RLN Relay](/getting-started/concepts/protocols#rln-relay) is a protocol being developed by the Waku team towards this goal. diff --git a/docs/overview/use-cases.md b/docs/getting-started/use-cases.md similarity index 100% rename from docs/overview/use-cases.md rename to docs/getting-started/use-cases.md diff --git a/docs/overview/why-waku.md b/docs/getting-started/why-waku.md similarity index 95% rename from docs/overview/why-waku.md rename to docs/getting-started/why-waku.md index 84b3c6c..59cf28b 100644 --- a/docs/overview/why-waku.md +++ b/docs/getting-started/why-waku.md @@ -11,7 +11,7 @@ Waku is intended to empower individuals by returning control of communication to - It is not confined to a particular blockchain. - It is modular, adaptable, and can cater to various use cases. - It allows developers to decentralize communication in their dApps or move actions off-chain while maintaining decentralization. -- It can run on various platforms, including mobile devices, cloud environments, web browsers, native desktop apps, or even a [Dappnode](https://dappnode.com/)! +- It can run on various platforms, including mobile devices, cloud environments, web browsers, desktop apps, or even a [Dappnode](https://dappnode.com/)! ## Why Waku is Necessary diff --git a/docs/platform/index.md b/docs/guides/sdks-and-nodes.md similarity index 65% rename from docs/platform/index.md rename to docs/guides/sdks-and-nodes.md index 8a5bad6..5587e86 100644 --- a/docs/platform/index.md +++ b/docs/guides/sdks-and-nodes.md @@ -1,39 +1,42 @@ --- -title: Getting Started With Waku -slug: /platform/overview +title: SDKs and Nodes --- :::caution Waku has risks and limitations as it is still developing and preparing for extensive adoption. However, it is already demonstrating its capabilities by [powering various applications](/powered-by-waku). [Join our community](/community) to stay updated on our progress. ::: -Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available integration options and contribute by operating a node. +Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available SDKs and contribute by operating a node. -## Run a Waku Node +## 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 for operators](https://github.com/waku-org/nwaku/tree/master/docs/operators) to learn more. +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) or [go-waku guide](https://github.com/waku-org/go-waku/tree/master/docs/operators) for operators to learn more. -## Integrate Using SDKs +## Integrate Using SDKs + +Waku is implemented in multiple SDKs, allowing it to easily integrate with different languages and address various use cases. | SDK | Description | Documentation | | - | - | - | -| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK recommended for operating a node and interacting with Waku | | | [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 recommended for operating a node and interacting with Waku | | | [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration in 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 | | +| [waku-ui](https://github.com/waku-org/waku-ui) | React components and UI adapters designed for seamless integration with `js-waku` | | ## Run on Mobile Devices +Waku provides integrations tailored for mobile applications, enabling Waku to operate efficiently on mobile devices. + | Language | Description | Documentation | | - | - | - | | [React Native](https://github.com/waku-org/waku-react-native) | React Native wrapper using `go-waku` bindings designed for native mobile integration | | -| Swift (iOS) | Swift applications can use `go-waku` bindings to seamlessly integrate Waku | | -| Kotlin (Android) | Kotlin applications can use `go-waku` bindings to seamlessly integrate Waku | | +| Swift (iOS) | `go-waku` bindings for Swift applications to seamlessly integrate Waku | | +| Kotlin (Android) | `go-waku` bindings for Kotlin applications to seamlessly integrate Waku | | -## Other Platforms +## More Integrations | Platform | Description | Documentation | | - | - | - | -| [waku-ui](https://github.com/waku-org/waku-ui) | React components and UI adapters designed for seamless integration with `js-waku` | | -| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next Waku project from various example templates | | -| JSON-RPC API | `JSON-RPC` API interface provided by nodes for seamless integration with Waku | | \ No newline at end of file +| JSON-RPC API | `JSON-RPC` API interface provided by nodes for seamless integration with Waku | | +| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next Waku project from various example templates | | \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index e2335b2..d46560d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -59,12 +59,12 @@ const config = { }, { type: "dropdown", - label: "Platforms", + label: "Guides", position: "right", items: [ { - label: "Overview", - to: "/platform/overview" + label: "SDKs and Nodes", + to: "/guides/sdks-and-nodes" } ] }, @@ -103,11 +103,11 @@ const config = { footer: { links: [ { - title: "Platforms", + title: "Guides", items: [ { - to: "/platform/overview", - label: "Overview" + to: "/guides/sdks-and-nodes", + label: "SDKs and Nodes" } ] }, @@ -115,11 +115,7 @@ const config = { title: "Community", items: [ { - href: "https://forum.vac.dev/", - label: "Forum" - }, - { - href: "https://discord.gg/Nrac59MfSX", + href: "https://discord.waku.org/", label: "Discord" }, { @@ -129,6 +125,10 @@ const config = { { href: "https://t.me/waku_org", label: "Telegram" + }, + { + href: "https://forum.vac.dev/", + label: "Vac Forum" } ] }, diff --git a/sidebars.js b/sidebars.js index b1e69a4..10886e8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -3,18 +3,18 @@ /** @type {import("@docusaurus/plugin-content-docs").SidebarsConfig} */ const sidebars = { main: [ - "overview/index", - "overview/history", - "overview/why-waku", - "overview/use-cases", + "getting-started/index", + "getting-started/history", + "getting-started/why-waku", + "getting-started/use-cases", { type: "link", - label: "Platforms", - href: "/platform/overview" + label: "SDKs and Nodes", + href: "/guides/sdks-and-nodes" }, { type: "link", - label: "Presentations", + label: "Video Presentations", href: "/presentations" }, { @@ -23,11 +23,11 @@ const sidebars = { collapsed: false, collapsible: true, items: [ - "overview/concepts/protocols", - "overview/concepts/peer-discovery", - "overview/concepts/network-domains", - "overview/concepts/content-topics", - "overview/concepts/transports" + "getting-started/concepts/protocols", + "getting-started/concepts/peer-discovery", + "getting-started/concepts/network-domains", + "getting-started/concepts/content-topics", + "getting-started/concepts/transports" ] }, { @@ -36,15 +36,15 @@ const sidebars = { collapsed: false, collapsible: true, items: [ - "overview/reference/glossary", - "overview/reference/security-features", - "overview/reference/research-in-progress", - "overview/reference/waku-vs-libp2p" + "getting-started/reference/glossary", + "getting-started/reference/security-features", + "getting-started/reference/research-in-progress", + "getting-started/reference/waku-vs-libp2p" ] } ], - platform: [ - "platform/index" + guides: [ + "guides/sdks-and-nodes" ], community: [ "powered-by-waku",