diff --git a/README.md b/README.md index 8443f08..c11acc6 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ git clone https://github.com/waku-org/waku.guide Install the dependencies: ```bash -yarn +npm install # or @@ -30,6 +30,10 @@ yarn install ## Running Locally ```bash +npm start + +# or + yarn start ``` @@ -37,6 +41,22 @@ Check for spelling errors before deploying: ```bash npm run check:spell + +# or + +yarn check:spell +``` + +Create a production build locally to check for errors: + +```bash +npm run build +npm run serve + +# or + +yarn build +yarn serve ``` ## Configuration @@ -73,5 +93,9 @@ You can find the instructions on adding more documentation sections, localizatio Docusaurus depends heavily on caching to enhance site performance. If you make changes that do not appear in the portal, try clearing the cache by running: ```bash +npm run clear + +# or + yarn clear ``` \ No newline at end of file diff --git a/docs/clients/js-waku/index.md b/docs/clients/js-waku/index.md index f4b182e..e5762b4 100644 --- a/docs/clients/js-waku/index.md +++ b/docs/clients/js-waku/index.md @@ -17,8 +17,8 @@ If you wish to use Waku with a NodeJS application, you can either: ::: -To get started, the [Quick Start](./quick-start) guide offers a simple way to integrate Waku into your web app. -For a more comprehensive tutorial, follow the [Build a Chat App](./build-chat-app) guide, +To get started, the [Quick Start](/) guide offers a simple way to integrate Waku into your web app. +For a more comprehensive tutorial, follow the [Build a Chat App](/) guide, which demonstrates how to create a chat app from scratch. Explore the [js-waku-examples repository](https://github.com/waku-org/js-waku-examples) to find various working Proof-of-Concepts that showcase how to use JS-Waku effectively. diff --git a/docs/contribute.md b/docs/contribute.md index 2a7f64b..f49fa0f 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -2,31 +2,27 @@ 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 [nwaku guide for operators](https://github.com/waku-org/nwaku/tree/master/docs/operators) to learn more. +Get involved in Waku's open-source initiatives to improve the protocol, SDKs, developer tools, and documentation. ## Build a Waku Application By integrating Waku into your application, you can contribute by: -- Running a Waku node within your application. +- [Running a Waku node](https://github.com/waku-org/nwaku/tree/master/docs/operators) 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! +Begin your journey by exploring [Waku's integration options](/sdk/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 +## Request 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 +## Make Pull Requests 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. diff --git a/docs/overview/clients.md b/docs/overview/clients.md deleted file mode 100644 index 165d6c8..0000000 --- a/docs/overview/clients.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Clients ---- - -Waku has been implemented in multiple programming languages to address various use cases. The Waku team builds and maintains each client, ensuring that updates are provided automatically. - -### [nwaku](https://github.com/waku-org/nwaku) - -The Nim implementation of the Waku protocol is the reference implementation recommended for deploying a node in the cloud or at home. - -### [js-waku](/clients/js-waku) - -The JavaScript/TypeScript implementation of the Waku protocol designed for use in browser environments. - -### [go-waku](https://github.com/waku-org/go-waku) - -The Golang implementation of the Waku protocol designed for native integration in Golang applications, includes C bindings with examples available in C#, Swift, and Kotlin. - -### [@waku/react-native](https://github.com/waku-org/waku-react-native) - -The React Native wrapper of the Waku protocol uses bindings provided by [go-waku](https://github.com/waku-org/go-waku) and is designed for native mobile integration. - -### [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) - -The Rust wrapper of the Waku protocol uses bindings provided by [go-waku](https://github.com/waku-org/go-waku) and is designed for Rust applications. \ No newline at end of file diff --git a/docs/sdk/index.md b/docs/sdk/index.md new file mode 100644 index 0000000..4852b8d --- /dev/null +++ b/docs/sdk/index.md @@ -0,0 +1,40 @@ +--- +title: Overview +slug: /sdk/overview +--- + +# Waku SDKs + +:::caution +While Waku comes with risks and limitations, as it is still in development and preparing for extensive adoption, 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 running a Waku node. + +## Running a Waku 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 [nwaku guide for operators](https://github.com/waku-org/nwaku/tree/master/docs/operators) to learn more. + +## Library Integration + +| SDK | Description | Documentation | +| - | - | - | +| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK recommended for deploying a node in the cloud or at home | | +| [js-waku](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | | +| [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for native integration in Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, Kotlin, and NodeJS | | +| [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using bindings provided by `go-waku` and is designed for Rust applications | | +| [waku-ui](https://github.com/waku-org/waku-ui) | React components and UI adapters designed for seamless integration with `js-waku` | | + +## API Integration + +| API Protocol | Description | Documentation | +| - | - | - | +| JSON-RPC | `JSON-RPC API` provided by Waku nodes for seamless access and interaction with the Waku network | | + +## Mobile Integration + +| Language | Description | Documentation | +| - | - | - | +| React Native | React Native wrapper using bindings provided by `go-waku` and is designed for mobile integration. | | +| Swift (iOS) | Swift applications can seamlessly integrate Waku with the C bindings provided by `go-waku`. | | +| Kotlin (Android) | Kotlin applications can seamlessly integrate Waku with the C bindings provided by `go-waku`. | | \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 2d7357d..da36e46 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -59,16 +59,12 @@ const config = { }, { type: "dropdown", - label: "Clients", + label: "Waku SDKs", position: "right", items: [ { label: "Overview", - to: "/overview/clients" - }, - { - label: "JS Waku", - to: "/clients/js-waku" + to: "/sdk/overview" } ] }, @@ -89,10 +85,6 @@ const config = { { label: "Contribute to Waku", to: "/contribute" - }, - { - label: "Gitcoin Bounties", - href: "https://bounties.gitcoin.co/status-im/bounties" } ] }, @@ -107,15 +99,11 @@ const config = { footer: { links: [ { - title: "Clients", + title: "SDKs", items: [ { - to: "/overview/clients", + to: "/sdk/overview", label: "Overview" - }, - { - to: "/clients/js-waku", - label: "JS Waku" } ] }, diff --git a/sidebars.js b/sidebars.js index b58df69..f7c0859 100644 --- a/sidebars.js +++ b/sidebars.js @@ -7,7 +7,11 @@ const sidebars = { "overview/history", "overview/why-waku", "overview/use-cases", - "overview/clients", + { + type: "link", + label: "Waku SDKs", + href: "/sdk/overview" + }, { type: "category", label: "Concepts", @@ -33,18 +37,13 @@ const sidebars = { ] } ], - js: [ - "clients/js-waku/index" + sdk: [ + "sdk/index" ], community: [ "powered-by-waku", "community", - "contribute", - { - type: "link", - label: "Gitcoin Bounties", - href: "https://bounties.gitcoin.co/status-im/bounties" - } + "contribute" ] };