mirror of
https://github.com/waku-org/waku.org.git
synced 2025-02-20 17:58:09 +00:00
Remove docs folder, various updates (#20)
This commit is contained in:
fryorcraken.eth
GitHub
parent
e74911b5c3
commit
01ad7b381e
@ -13,6 +13,7 @@
|
||||
"supercrypto",
|
||||
"RAILGUN",
|
||||
"unlinkability",
|
||||
"Waku"
|
||||
"Waku",
|
||||
"XMTP"
|
||||
]
|
||||
}
|
||||
|
||||
@ -28,7 +28,7 @@
|
||||
"operator.md",
|
||||
"contribute.md"
|
||||
],
|
||||
"folderOrdersInSidenav": ["docs"],
|
||||
"folderOrdersInSidenav": [],
|
||||
"external_links": [
|
||||
{
|
||||
"text": "Blog",
|
||||
@ -47,7 +47,7 @@
|
||||
},
|
||||
{
|
||||
"text": "Careers",
|
||||
"url": "https://status.im/our_team/jobs.html",
|
||||
"url": "https://jobs.status.im/",
|
||||
"category": "Links"
|
||||
},
|
||||
{
|
||||
@ -79,7 +79,7 @@
|
||||
},
|
||||
{
|
||||
"provider": "github",
|
||||
"handler": "status-im/?q=waku&type=&language=&sort="
|
||||
"handler": "waku-org"
|
||||
},
|
||||
{
|
||||
"provider": "telegram",
|
||||
|
||||
@ -11,7 +11,7 @@ You can contribute to Waku in several manners:
|
||||
The Waku Network is a permissionless, decentralized set of nodes.
|
||||
Anyone can run their own node, use and support the network.
|
||||
|
||||
Learn more [here](/contribute).
|
||||
Learn more [here](https://github.com/status-im/nwaku/tree/master/docs/operators).
|
||||
|
||||
## Build Your Own Waku Application
|
||||
|
||||
@ -34,9 +34,9 @@ potential bounties are marked with the label `bounty` on GitHub issues.
|
||||
|
||||
Repositories:
|
||||
|
||||
- [js-waku](https://github.com/status-im/js-waku)
|
||||
- [js-waku](https://github.com/waku-org/js-waku)
|
||||
- [nwaku](https://github.com/status-im/nwaku)
|
||||
- [go-waku](https://github.com/status-im/go-waku)
|
||||
- [go-waku](https://github.com/waku-org/go-waku)
|
||||
|
||||
## Research
|
||||
|
||||
|
||||
@ -1,28 +0,0 @@
|
||||
---
|
||||
title: Docs
|
||||
---
|
||||
|
||||
# Waku Docs
|
||||
|
||||
Waku is a decentralized, censorship-resistant, network and protocol family.
|
||||
It enables you to add communication features to your dApp in a decentralized manner,
|
||||
ensuring to your users that they will not be censored or de-platformed.
|
||||
|
||||
Waku can be used for chat purposes and for many machine-to-machine use cases.
|
||||
|
||||
Finally, if you want to learn how Waku works under the hoods, check the specs at [rfc.vac.dev](https://rfc.vac.dev/).
|
||||
|
||||
## Documentation
|
||||
|
||||
We are currently in the process of migrating our documentation.
|
||||
For now, please go to the following location to learn more about Waku:
|
||||
|
||||
- [Waku General Concepts](/docs/main)
|
||||
- [js-waku](https://docs.wakuconnect.dev/)
|
||||
- [nwaku](https://github.com/status-im/nwaku)
|
||||
- [go-waku](https://github.com/status-im/go-waku)
|
||||
|
||||
## Bugs, Questions & Support
|
||||
|
||||
To get help, join [Vac Discord](https://discord.gg/j5pGbn7MHZ)
|
||||
or the [Waku Telegram Group](https://t.me/waku_org).
|
||||
@ -1,30 +0,0 @@
|
||||
---
|
||||
title: How to Choose a Content Topic
|
||||
---
|
||||
|
||||
# How to Choose a Content Topic
|
||||
|
||||
A content topic is used for content based filtering.
|
||||
|
||||
It allows you to filter out the messages that your dApp processes,
|
||||
both when receiving live messages (Relay) or retrieving historical messages (Store).
|
||||
|
||||
The format for content topics is as follows:
|
||||
|
||||
`/{dapp-name}/{version}/{content-topic-name}/{encoding}`
|
||||
|
||||
- `dapp-name`: The name of your dApp, it must be unique to avoid conflict with other dApps.
|
||||
- `version`: We usually start at `1`, useful when introducing breaking changes in your messages.
|
||||
- `content-topic-name`: The actual content topic name to use for filtering.
|
||||
If your dApp uses Waku Connect for several features,
|
||||
you should use a content topic per feature.
|
||||
- `encoding`: The encoding format of the message, Protobuf is most often used: `proto`.
|
||||
|
||||
For example: Your dApp's name is SuperCrypto,
|
||||
it enables users to receive notifications and send private messages.
|
||||
You may want to use the following content topics:
|
||||
|
||||
- `/supercrypto/1/notification/proto`
|
||||
- `/supercrypto/1/private-message/proto`
|
||||
|
||||
You can learn more about Waku topics in the [23/WAKU2-TOPICS](https://rfc.vac.dev/spec/23/) specs.
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
title: General Concepts
|
||||
---
|
||||
|
||||
# Waku General Concepts
|
||||
|
||||
This documentation contains general information about Waku.
|
||||
|
||||
It is aimed to be a more accessible than the [Waku v2 RFCs](https://rfc.vac.dev/spec/10/).
|
||||
|
||||
## Guides
|
||||
|
||||
- [How to Choose a Content Topic](/docs/main/choose-content-topic)
|
||||
26
main.md
26
main.md
@ -6,7 +6,7 @@ Waku is the communication layer for Web3. Decentralized communication that scale
|
||||
|
||||
Private. Secure. Runs anywhere.
|
||||
|
||||
[Check the docs](https://docs.wakuconnect.dev/)
|
||||
[Check the docs](https://js.waku.guide/)
|
||||
|
||||
## What is Waku?
|
||||
|
||||
@ -53,12 +53,6 @@ Status is a secure messaging app, crypto wallet, and Web3 browser built with sta
|
||||
|
||||
[Visit Status](https://status.im/)
|
||||
|
||||
### WalletConnect
|
||||
|
||||
WalletConnect v2 is using Waku v2 for decentralized messaging infrastructure.
|
||||
|
||||
[Visit WalletConnect](https://walletconnect.com/)
|
||||
|
||||
### RAILGUN
|
||||
|
||||
RAILGUN is a privacy system for Ethereum that shields your assets in your own smart contract wallet.
|
||||
@ -67,6 +61,12 @@ privately signaling fees and offers for gas payment relayers to keep the privacy
|
||||
|
||||
[Visit RAILGUN](https://railgun.org/)
|
||||
|
||||
### XMTP
|
||||
|
||||
XMTP is using Waku v2 for their open protocol and network for secure web3 messaging.
|
||||
|
||||
[Visit XMTP](https://xmtp.com/)
|
||||
|
||||
## Implementations
|
||||
|
||||
### nwaku
|
||||
@ -80,17 +80,23 @@ Reference client and flagship implementation.
|
||||
|
||||
A JavaScript implementation for browser environments.
|
||||
|
||||
[js-waku docs](https://docs.wakuconnect.dev/)
|
||||
[js-waku docs](https://js.waku.guide/)
|
||||
|
||||
### go-waku
|
||||
|
||||
A Go implementation for native integration in go applications,
|
||||
C-Bindings are also available with C#, Swift and Kotlin examples.
|
||||
|
||||
[go-waku repository](https://github.com/status-im/go-waku)
|
||||
[go-waku repository](https://github.com/waku-org/go-waku)
|
||||
|
||||
### @waku/react-native
|
||||
|
||||
Integrate Waku in your React Native app using go-waku for mobile.
|
||||
|
||||
[@waku/react-native repo](https://github.com/status-im/waku-react-native)
|
||||
[@waku/react-native repo](https://github.com/waku-org/waku-react-native)
|
||||
|
||||
### Waku Rust Bindings
|
||||
|
||||
Rust layer on top of go-waku C FFI bindings.
|
||||
|
||||
[waku-rust-bindings repo](https://github.com/waku-org/waku-rust-bindings)
|
||||
|
||||
@ -2,15 +2,15 @@
|
||||
"name": "@waku/waku.org",
|
||||
"version": "1.0.0",
|
||||
"main": "\"\"",
|
||||
"repository": "git@github.com:vacp2p/waku.org.git",
|
||||
"repository": "git@github.com:waku-org/waku.org.git",
|
||||
"author": "Franck Royer <franck@status.im>",
|
||||
"license": "MIT OR Apache-2.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"fix": "prettier \"*.md\" \"docs/**/*.md\" \"./*.json\" --write",
|
||||
"fix": "prettier \"*.md\" \"./*.json\" --write",
|
||||
"test": "run-p test:**",
|
||||
"test:format": "prettier \"*.md\" \"docs/**/*.md\" \"./*.json\" --list-different",
|
||||
"test:spelling": "cspell \"*.md\" \"docs/**/*.md\" config.json",
|
||||
"test:format": "prettier \"*.md\" \"./*.json\" --list-different",
|
||||
"test:spelling": "cspell \"*.md\" config.json",
|
||||
"prepare": "husky install"
|
||||
},
|
||||
"lint-staged": {
|
||||
|
||||
@ -30,9 +30,10 @@ It is possible to integrate Waku as a library.
|
||||
| Your Application's language | What to Use | Links |
|
||||
| --------------------------- | ------------------------ | ----------------------------------------------------------------------------------- |
|
||||
| Nim | nwaku as a library | [repository](https://github.com/status-im/nwaku/tree/master/waku/v2) |
|
||||
| Go | go-waku as a library | [tutorials](https://github.com/status-im/go-waku#tutorials-and-documentation) |
|
||||
| C | go-waku using C-Bindings | [C example](https://github.com/status-im/go-waku/tree/master/examples/c-bindings) |
|
||||
| Go | go-waku as a library | [tutorials](https://github.com/waku-org/go-waku#tutorials-and-documentation) |
|
||||
| C/C++/etc | go-waku using C-Bindings | [C example](https://github.com/status-im/go-waku/tree/master/examples/c-bindings) |
|
||||
| C# | go-waku using C-Bindings | [C# example](https://github.com/status-im/go-waku/tree/master/examples/waku-csharp) |
|
||||
| Rust | Waku Rust Bindings | [Rust example](https://github.com/waku-org/waku-rust-bindings/tree/master/examples) |
|
||||
|
||||
## Browser Application
|
||||
|
||||
@ -40,7 +41,7 @@ It is possible to integrate Waku as a library.
|
||||
|
||||
You can use js-waku to run a Waku node in the browser.
|
||||
|
||||
Docs: https://docs.wakuconnect.dev/
|
||||
Docs: https://js.waku.guide/
|
||||
|
||||
## Mobile Application
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user