waku-org
/
docs.waku.org
mirror of https://github.com/waku-org/docs.waku.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from waku-org/add-docs 

configure website, add documentation
This commit is contained in:
fryorcraken.eth 2022-07-29 16:29:27 +10:00 committed by GitHub
parent a717e63e3b 75dfb9fa47
commit 437b806663
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 97 additions and 199 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
about.md
View File

@ -1,32 +0,0 @@
---
title: About
category: page
---
## Quod per
Differt intrat purpura: habitandae sic! Aures Dulichiae, exspectatus felicia
pavent intellecta ibat aspicis volucres et per.
> Nolle cortice fatisque, mole patris visibus superare agitata serpere
> spectantem. Funera loca mihi sed [urnam
> ulterius](http://tectus.net/additisveniam) sunt Peleu soluto; Augusto via.
> Tibi vix et nec sua poma accingitur; ipsas culpam cornus: paludes Tereus!
> Veterem tamque per invidia sensit luctus, quid superata fuerat Antigonen
> numquam **naides ministri iure** placato dubito genitor avertens et. Pomo
> surgit et et esset et modo.
## Mitia prospectet fugit vel tutaeque abiit opus
## Si Libys transformat fuerat dederatque mergor
Lorem markdownum Euboico quis si hac aemulus, corporis intus; illi times
[mercede](http://quamvis.org/indeproxima.html). Hunc nato conclamat Pulchrior
quo. Qui tandem Venus, inque quos urbe durasse bracchia suo. Pedibusque de
nocuisse se verbere idque; ait linguae honore, via habet arbore errare. Erat ubi
dum regna sceleri: meus obsidis felix undas adopertaque ortu.
1. Convaluit esse vipereasque tibi fortis sponte
2. Partibus tendentem poenam sumpsisse ab nisi
3. Limina quodcunque saepe cum bracchia patremque tale
4. Credidit in auras murum

55
config.json
View File

@ -20,38 +20,69 @@
"template": "default",
"static_assets_folder": "static-assets",
"navigation": {
"home": "main.md",
"home": "index.md",
"fileOrdersInSidenav": [
"main.md",
"about.md"
"index.md"
],
"folderOrdersInSidenav": [
"docs"
],
"folderOrdersInSidenav": [],
"external_links": [
{
"text": "Waku",
"url": "https://waku.org/",
"category": "Links"
},
{
"text": "Blog",
"url": "https://vac.dev/research",
"category": "Links"
},
{
"text": "Vac",
"url": "https://vac.dev/",
"category": "Links"
},
{
"text": "Waku RFCs",
"url": "https://rfc.vac.dev/spec/10//",
"category": "Links"
},
{
"text": "Careers",
"url": "https://status.im/our_team/jobs.html",
"category": "Links"
},
{
"text": "Discord",
"url": "https://discord.gg/j5pGbn7MHZ",
"category": "Connect"
},
{
"text": "Twitter",
"url": "https://twitter.com/waku_org",
"category": "Connect"
}
]
},
"ds_id": "waku",
"seo": {
"title": "title of your site",
"description": "description of your site",
"image": "your-site-preview-image.png",
"url": "https://yoursitedomain.org",
"title": "Waku Guide",
"description": "Waku is the communication layer for Web3. Decentralized communication that scales. Private, secure, and it runs anywhere.",
"image": "waku-site-preview-image.png",
"url": "https://waku.guide",
"social_media": [
{
"provider": "twitter",
"handler": "your_tw_handler"
"handler": "waku_org"
},
{
"provider": "discord",
"handler": "your_dsc_handler"
"handler": "j5pGbn7MHZ"
},
{
"provider": "github",
"handler": "your_gh_handler"
"handler": "status-im/?q=waku&type=&language=&sort="
},
{
"provider": "telegram",
@ -59,7 +90,7 @@
},
{
"provider": "discourse",
"handler": "your_disc_address"
"handler": "forum.vac.dev"
}
]
}

30
docs/choose-content-topic.md Normal file
View File

@ -0,0 +1,30 @@
---
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.

89
index.md
View File

@ -1,70 +1,29 @@
```ascii
+--------------------------------------------------------+ +------------------------------------------------------+
| | | |
| | | |
| VAC | | CODEX |
| | | +--------------+ |
| | | | | |
| +----------------+ +------------------+ | | | | |
| | | | | | | | | |
| | | | PROTOCOL | | +-----+--------+ RESEARCH | |
| | PRINCIPLES +-----+----+ DEVELOPMENT | | | | | | |
| | | | | PROCESS | | | | | | +-------------+ |
| | | | | | | | | | | | | |
| +----------------+ | +------------------+ | | | +--------------+ | | |
| | | | | | OPINIATED | |
| | | | | +------> PRODUCTS | |
| | | | | | | | |
| | | | | +--------------+ | | | |
| +-------------v---------------+ | | | | | | | | |
| | <------------+----+ | | | | +-------------+ |
| | | | | | +-----+ |
| | AGNOSTIC SPECIFICATIONS | | | | ENGINEERING | |
| | +------------+----------+--------> | |
| | | | | | | |
| +-------------+---------------+ | | | | |
| | | | +--------------+ |
| | | | |
| | | | |
+---------------------------+----------------------------+ +------------------------------------------------------+
|
|
|
|
v
+----------------------------+
| |
| |
| UNOPINIONATED PROTOCOLS |
| |
| |
+----------------------------+
```
---
title: Waku Guide
---
Normal textNormal textNormal textNormal textNormal textNormal textNormal textNormal textNormal textNormal textNormal textNormal textNormal textNormal text.
# Waku Guide
```paragraph
The Pyramid of Sahure (Ancient Egyptian: Ḫꜥỉ-bꜣ Sꜣḥw-Rꜥ, lit. 'Rising of the ba of Sahure'; Arabic: هرم ساحورع, romanized: Haram Sahawrae) is a pyramid complex built in the late 26th to 25th century BC for the Egyptian pharaoh Sahure of the Fifth Dynasty.[10][a] It introduced a period of pyramid building by Sahure's successors in Abusir, on a location earlier used by Userkaf for his sun temple. The site was first thoroughly excavated by Ludwig Borchardt between March 1907 and 1908, who wrote the standard work Das Grabdenkmal des Königs Sahu-Re (English: The Funerary Monument of King Sahure) between 1910 and 1913.
The pyramid complex's layout was adopted by succeeding kings of the Fifth and Sixth Dynasties, marking a milestone in pyramid complex construction. Compared to the preceding Fourth Dynasty, the immensity of the constructions was dramatically reduced but, in tandem, the decorative programme proliferated and temples were augmented by enlarged storeroom complexes. The complex is estimated to.
```
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.
```mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```
Waku can be used for chat (human-to-human) purposes and for many machine-to-machine use cases.
![Drag Racing](./static-assets/image-1.jpeg)
Here you can find general, high level explanation of Waku concepts.
```tsx
const sum = (a, b) => {
return a+b;
}
console.log(sum(2+2));
```
If you want to learn how Waku works under the hoods, check out the [10/WAKU2](https://rfc.vac.dev/spec/10/) RFC.
## Implementation Documentation
We are currently in the process of migrating our documentation 🏗️.
For now, please go to the following location to learn more about the different Waku implementations:
- [nwaku](https://github.com/status-im/nwaku)
- [js-waku](https://docs.wakuconnect.dev/)
- [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).

36
research/index.md
View File

@ -1,36 +0,0 @@
---
title: research
---
# Saepe ne iura
Differt intrat purpura: habitandae sic! Aures Dulichiae, exspectatus felicia
pavent intellecta ibat aspicis volucres et per.
> Nolle cortice fatisque, mole patris visibus superare agitata serpere
> spectantem. Funera loca mihi sed [urnam
> ulterius](http://tectus.net/additisveniam) sunt Peleu soluto; Augusto via.
> Tibi vix et nec sua poma accingitur; ipsas culpam cornus: paludes Tereus!
> Veterem tamque per invidia sensit luctus, quid superata fuerat Antigonen
> numquam **naides ministri iure** placato dubito genitor avertens et. Pomo
> surgit et et esset et modo.
## Mitia prospectet fugit vel tutaeque abiit opus
Ira ducum, requiescit conatur **occupat sacros adigitque** oculos fontem.
Ferventibus pretium cuius. Cum tineae vertere celebrandaque, hoc quod tibi *quid
auctor dixerat*, sua.
Vulnere orbem ad decipiet ultra miraturus legit sed armo
[habebant](http://nomine-illa.io/non-qua.php)! Et rumpunt ferro est fetum, in
est expellitque lateat! Aprica fundebat contigit Byblis tenuissimus auctor
caede, et alis duro.
Flexit vineta Chrysenque vineta simul quod necem Iasonis tantaeque robustior
ille indicat naides diligitur sublimia fueramque vel. Nomen est in sed praeterit
veras tempora, Iove hausta? Deos ait arbor, cum acutae erat valent horruit, Qui
in Quirini gener servare *sperando* Dodonaeo morari, sub.
Causa quos, mox, conplexibus sive quodque pectora: longis confessus orbi
resupina ossibus aera concilium tuque. Vulnus flumina. Prima ut Phineus anum
cornibus sentite tonitribus super. Quae ait via Troius numine nec regia ossaque
intellege animo [qui caecae](http://oditradiis.com/) motamque, erat **colubras
dicta** dies.

54
research/research-a.md
View File

@ -1,54 +0,0 @@
---
title: An amazing blog post
category: research
---
# Saepe ne iura
## Si Libys transformat fuerat dederatque mergor
Lorem markdownum Euboico quis si hac aemulus, corporis intus; illi times
[mercede](http://quamvis.org/indeproxima.html). Hunc nato conclamat Pulchrior
quo. Qui tandem Venus, inque quos urbe durasse bracchia suo. Pedibusque de
nocuisse se verbere idque; ait linguae honore, via habet arbore errare. Erat ubi
dum regna sceleri: meus obsidis felix undas adopertaque ortu.
1. Convaluit esse vipereasque tibi fortis sponte
2. Partibus tendentem poenam sumpsisse ab nisi
3. Limina quodcunque saepe cum bracchia patremque tale
4. Credidit in auras murum
## Quod per
Differt intrat purpura: habitandae sic! Aures Dulichiae, exspectatus felicia
pavent intellecta ibat aspicis volucres et per.
> Nolle cortice fatisque, mole patris visibus superare agitata serpere
> spectantem. Funera loca mihi sed [urnam
> ulterius](http://tectus.net/additisveniam) sunt Peleu soluto; Augusto via.
> Tibi vix et nec sua poma accingitur; ipsas culpam cornus: paludes Tereus!
> Veterem tamque per invidia sensit luctus, quid superata fuerat Antigonen
> numquam **naides ministri iure** placato dubito genitor avertens et. Pomo
> surgit et et esset et modo.
## Mitia prospectet fugit vel tutaeque abiit opus
Ira ducum, requiescit conatur **occupat sacros adigitque** oculos fontem.
Ferventibus pretium cuius. Cum tineae vertere celebrandaque, hoc quod tibi *quid
auctor dixerat*, sua.
Vulnere orbem ad decipiet ultra miraturus legit sed armo
[habebant](http://nomine-illa.io/non-qua.php)! Et rumpunt ferro est fetum, in
est expellitque lateat! Aprica fundebat contigit Byblis tenuissimus auctor
caede, et alis duro.
Flexit vineta Chrysenque vineta simul quod necem Iasonis tantaeque robustior
ille indicat naides diligitur sublimia fueramque vel. Nomen est in sed praeterit
veras tempora, Iove hausta? Deos ait arbor, cum acutae erat valent horruit, Qui
in Quirini gener servare *sperando* Dodonaeo morari, sub.
Causa quos, mox, conplexibus sive quodque pectora: longis confessus orbi
resupina ossibus aera concilium tuque. Vulnus flumina. Prima ut Phineus anum
cornibus sentite tonitribus super. Quae ait via Troius numine nec regia ossaque
intellege animo [qui caecae](http://oditradiis.com/) motamque, erat **colubras
dicta** dies.

BIN
static-assets/image-1.jpeg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 162 KiB

BIN
static-assets/waku-site-preview-image.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB