acid-info
/
docs.wakuconnect.dev
mirror of https://github.com/acid-info/docs.wakuconnect.dev.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

js-waku docs are now hosted at a new location (#30)

This commit is contained in:
Franck R 2022-01-27 11:18:41 +11:00 committed by GitHub
parent 41bc0a9d80
commit 02d5ab77d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config.yaml
View File

@ -1,7 +1,7 @@
baseURL: "https://docs.wakuconnect.dev/"
languageCode: "en-us"
defaultContentLang: en
title: "WakuConnect Docs"
title: "Waku Connect Docs"
theme: "hugo-book"
enableGitInfo: true
@ -9,7 +9,7 @@ menu:
before: []
after:
- name: "JS-Waku API Doc"
url: "https://status-im.github.io/js-waku/docs/"
url: "https://js-waku.wakuconnect.dev/"
weight: 5
- name: "Vac Team"
url: "https://vac.dev/"

2
content/docs/guides/01_choose_content_topic.md
View File

@ -18,7 +18,7 @@ The format for content topics is as follows:
- `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 WakuConnect for several features,
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`.

2
content/docs/guides/07_reactjs_relay.md
View File

@ -6,7 +6,7 @@ weight: 7
# Receive and Send Messages Using Waku Relay With ReactJS
It is easy to use WakuConnect with ReactJS.
It is easy to use Waku Connect with ReactJS.
In this guide, we will demonstrate how your ReactJS dApp can use Waku Relay to send and receive messages.
Before starting, you need to choose a _Content Topic_ for your dApp.

2
content/docs/guides/08_reactjs_store.md
View File

@ -6,7 +6,7 @@ weight: 8
# Retrieve Messages Using Waku Store With ReactJS
It is easy to use WakuConnect with ReactJS.
It is easy to use Waku Connect with ReactJS.
In this guide, we will demonstrate how your ReactJS dApp can use Waku Store to retrieve messages.
DApps running on a phone or in a browser are often offline:

16
content/docs/guides/vote_poll_sdk/_index.md
View File

@ -2,9 +2,9 @@
weight: 100
---
# WakuConnect Vote & Poll SDK
# Waku Connect Vote & Poll SDK
The WakuConnect Vote & Poll SDK enables developers to add Waku powered polling and voting features to their dApp.
The Waku Connect Vote & Poll SDK enables developers to add Waku powered polling and voting features to their dApp.
The repository can be found on GitHub: https://github.com/status-im/wakuconnect-vote-poll-sdk.
@ -32,9 +32,9 @@ The developer using the SDK can configure which ERC-20 token contract is used.
- `@waku/poll-sdk-react-components`: React components.
- `@waku/poll-sdk-react-hooks`: React hooks.
## WakuConnect Vote SDK
## Waku Connect Vote SDK
The WakuConnect Vote SDK allows you to leverage Waku to save gas fees for most voters.
The Waku Connect Vote SDK allows you to leverage Waku to save gas fees for most voters.
It uses Waku to broadcast and aggregate votes.
Most token holders will not need to spend gas to vote.
@ -43,7 +43,7 @@ Only the party that starts an election and submit the end results need to intera
For example, it can be used by a DAO to manage proposals
where proposal creation and vote results must be committed to the blockchain.
With WakuConnect Vote SDK, the DAO could be the one spending gas when creating the proposal and committing the votes,
With Waku Connect Vote SDK, the DAO could be the one spending gas when creating the proposal and committing the votes,
whereas the token holders do not spend gas when voting.
### Documentation
@ -64,9 +64,9 @@ there may be issues with undeclared dependencies with this example.
Tracked with [status-im/wakuconnect-vote-poll-sdk#11](https://github.com/status-im/wakuconnect-vote-poll-sdk/issues/11).
{{< /hint >}}
## WakuConnect Poll SDK
## Waku Connect Poll SDK
The WakuConnect Poll SDK allows you to leverage Waku and enable token holders to create, answer and view polls.
The Waku Connect Poll SDK allows you to leverage Waku and enable token holders to create, answer and view polls.
The polls are not committed to the blockchain and hence do not cost gas.
As the polls use Waku, they do maintain properties expected from dApps: decentralized and censorship-resistant.
@ -82,4 +82,4 @@ The high-level functionality is as follows:
### Documentation
See [How to Use the WakuConnect Poll SDK](./poll_sdk).
See [How to Use the Waku Connect Poll SDK](./poll_sdk).

2
content/docs/guides/vote_poll_sdk/poll_sdk/01_create_dapp.md
View File

@ -25,7 +25,7 @@ yarn add -D @types/styled-components
{{< hint warning >}}
`@usedapp/core` must be frozen to version `0.4.7` due to incompatibility between minor versions of `ethers`.
WakuConnect Vote & Poll SDK will be upgraded to the latest version of `@usedapp/core` and `ethers` once `ethereum-waffle`
Waku Connect Vote & Poll SDK will be upgraded to the latest version of `@usedapp/core` and `ethers` once `ethereum-waffle`
is released with the [latest version of `ethers`](https://github.com/EthWorks/Waffle/pull/603).
{{< /hint >}}

4
content/docs/guides/vote_poll_sdk/poll_sdk/_index.md
View File

@ -4,9 +4,9 @@ date: 2022-01-03T11:00:00+1100
weight: 1
---
# How to Use the WakuConnect Poll SDK
# How to Use the Waku Connect Poll SDK
To demonstrate how to use the WakuConnect Poll SDK in your dApp, we will create a TypeScript React app from scratch.
To demonstrate how to use the Waku Connect Poll SDK in your dApp, we will create a TypeScript React app from scratch.
You can then adapt the steps depending on your dApp configuration and build setup.

8
content/docs/introduction.md
View File

@ -4,9 +4,9 @@ date: 2021-12-09T14:00:00+01:00
weight: 10
---
# WakuConnect Docs
# Waku Connect Docs
WakuConnect is a suite of libraries, SDKs and documentations to help you use Waku in your dApp.
Waku Connect is a suite of libraries, SDKs and documentations to help you use Waku in your dApp.
Waku is a decentralized, censorship-resistant, network and protocol family.
It enables you to add communication features to your dApp in a decentralized manner,
@ -37,5 +37,5 @@ Finally, if you want to learn how Waku works under the hoods, check the specs at
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/status-im/js-waku/issues/new/).
To get help, join #dappconnect-support on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or [Telegram](https://t.me/dappconnectsupport).
For more general discussion and latest news, join #dappconnect on [Vac Discord](https://discord.gg/9DgykdmpZ6) or [Telegram](https://t.me/dappconnect).
To get help, join #wakuconnect-support on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or [Telegram](https://t.me/wakuconnectsupport).
For more general discussion and latest news, join #wakuconnect on [Vac Discord](https://discord.gg/9DgykdmpZ6) or [Telegram](https://t.me/wakuconnect).

4
content/docs/presentations.md
View File

@ -16,7 +16,7 @@ Slides: https://notes.status.im/eth-global-2021
## 21 Jul 2021 - EthCC 2021
_Note: DappConnect is now named WakuConnect._
_Note: DappConnect is now named Waku Connect._
{{< youtube rQOp3qoDF0g >}}
@ -24,7 +24,7 @@ Slides: https://notes.status.im/dappconnect-pres
## 21 Jul 2021 - Ethereum Engineering Group meetup
_Note: DappConnect is now named WakuConnect._
_Note: DappConnect is now named Waku Connect._
{{< youtube CBknF-6Z-Ds >}}

6
content/docs/use_cases.md
View File

@ -33,7 +33,7 @@ Legend:
Waku can be used as the communication layer to a private, decentralized, censorship-resistant messenger.
- WakuConnect Chat SDK: [repo](https://github.com/status-im/dappconnect-chat-sdk)
- Waku Connect Chat SDK: [repo](https://github.com/status-im/wakuconnect-chat-sdk)
<--->
@ -44,7 +44,7 @@ Waku can be used as the communication layer to a private, decentralized, censors
Create, answer and view polls which are censorship-resistant.
- WakuConnect Poll SDK:
- Waku Connect Poll SDK:
[docs](/docs/guides/vote_poll_sdk/#wakuconnect-poll-sdk),
[repo](https://github.com/status-im/wakuconnect-vote-poll-sdk)
@ -88,7 +88,7 @@ Votes can then be aggregated and submitted to the blockchain to commit the resul
Create, answer and view polls which are censorship-resistant.
- WakuConnect Vote SDK:
- Waku Connect Vote SDK:
[docs](/docs/guides/vote_poll_sdk/#wakuconnect-vote-sdk),
[repo](https://github.com/status-im/wakuconnect-vote-poll-sdk)