mirror of
https://github.com/waku-org/docs.waku.org.git
synced 2025-02-22 09:48:11 +00:00
more reorg
This commit is contained in:
LordGhostX
parent
7cc4fe75b1
commit
85aeac7b5b
24
README.md
24
README.md
@ -20,42 +20,28 @@ git clone https://github.com/waku-org/waku.guide
|
||||
Install the dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
|
||||
# or
|
||||
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Running Locally
|
||||
|
||||
```bash
|
||||
npm start
|
||||
|
||||
# or
|
||||
|
||||
yarn start
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
# test the build
|
||||
|
||||
yarn serve
|
||||
```
|
||||
|
||||
@ -93,9 +79,5 @@ 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
|
||||
```
|
||||
@ -4,7 +4,7 @@ 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.
|
||||
|
||||
## [Forum](https://forum.vac.dev/)
|
||||
## [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!
|
||||
|
||||
|
||||
@ -8,11 +8,11 @@ Get involved in Waku's open-source initiatives to improve the protocol, SDKs, de
|
||||
|
||||
By integrating Waku into your application, you can contribute by:
|
||||
|
||||
- [Operating a node](https://github.com/waku-org/nwaku/tree/master/docs/operators) within your application.
|
||||
- [Running a 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 integration options](/sdk/overview) and start building today!
|
||||
Begin your journey by exploring the [Waku platforms](/platform/overview) and start building today!
|
||||
|
||||
## Report a Bug
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Getting Started With Waku
|
||||
slug: /sdk/overview
|
||||
slug: /platform/overview
|
||||
---
|
||||
|
||||
:::caution
|
||||
@ -9,11 +9,11 @@ Waku has risks and limitations as it is still developing and preparing for exten
|
||||
|
||||
Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available integration options and contribute by operating a node.
|
||||
|
||||
## Operating a Waku Node
|
||||
## Run a Waku Node
|
||||
|
||||
The Waku network is permissionless and decentralized, consisting of nodes. It is open for anyone to operate 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 for operators](https://github.com/waku-org/nwaku/tree/master/docs/operators) to learn more.
|
||||
|
||||
## SDK Integrations
|
||||
## Integrate Using SDKs
|
||||
|
||||
| SDK | Description | Documentation |
|
||||
| - | - | - |
|
||||
@ -22,23 +22,18 @@ The Waku network is permissionless and decentralized, consisting of nodes. It is
|
||||
| [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 | |
|
||||
|
||||
## API Integration
|
||||
|
||||
| API Protocol | Description | Documentation |
|
||||
| - | - | - |
|
||||
| JSON-RPC | `JSON-RPC` API provided by nodes for seamless integration with Waku | |
|
||||
|
||||
## Mobile Integrations
|
||||
## Run on Mobile Devices
|
||||
|
||||
| Language | Description | Documentation |
|
||||
| - | - | - |
|
||||
| React Native | React Native wrapper using `go-waku` bindings designed for native mobile integration | |
|
||||
| [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 | |
|
||||
|
||||
## Other Integrations
|
||||
## Other Platforms
|
||||
|
||||
| SDK | Description | Documentation |
|
||||
| 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 | |
|
||||
| [@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 | |
|
||||
@ -30,7 +30,7 @@ import PoweredByCard from "@site/src/components/PoweredByCard";
|
||||
RAILGUN uses Waku to offer private gas payments to users, ensuring anonymity and privacy for their transactions.
|
||||
</PoweredByCard>
|
||||
<PoweredByCard
|
||||
appLink="https://github.com/graphops/graphcast-sdk"
|
||||
appLink="https://thegraph.com/"
|
||||
logoSrc="/img/the-graph-logo.svg"
|
||||
logoAlt="The Graph icon"
|
||||
>
|
||||
|
||||
@ -59,12 +59,12 @@ const config = {
|
||||
},
|
||||
{
|
||||
type: "dropdown",
|
||||
label: "Waku SDKs",
|
||||
label: "Platforms",
|
||||
position: "right",
|
||||
items: [
|
||||
{
|
||||
label: "Overview",
|
||||
to: "/sdk/overview"
|
||||
to: "/platform/overview"
|
||||
}
|
||||
]
|
||||
},
|
||||
@ -103,10 +103,10 @@ const config = {
|
||||
footer: {
|
||||
links: [
|
||||
{
|
||||
title: "Waku SDKs",
|
||||
title: "Platforms",
|
||||
items: [
|
||||
{
|
||||
to: "/sdk/overview",
|
||||
to: "/platform/overview",
|
||||
label: "Overview"
|
||||
}
|
||||
]
|
||||
|
||||
@ -9,8 +9,8 @@ const sidebars = {
|
||||
"overview/use-cases",
|
||||
{
|
||||
type: "link",
|
||||
label: "Waku SDKs",
|
||||
href: "/sdk/overview"
|
||||
label: "Platforms",
|
||||
href: "/platform/overview"
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
@ -42,8 +42,8 @@ const sidebars = {
|
||||
]
|
||||
}
|
||||
],
|
||||
sdk: [
|
||||
"sdk/index"
|
||||
platform: [
|
||||
"platform/index"
|
||||
],
|
||||
community: [
|
||||
"powered-by-waku",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user