diff --git a/standards/application/qaku.md b/standards/application/qaku.md index bee7bb4..096f7ac 100644 --- a/standards/application/qaku.md +++ b/standards/application/qaku.md @@ -10,16 +10,16 @@ contributors: ## Abstract -The document describes the Qaku web application bulit with Waku. -The use of Waku LightPush .... +The document describes the functions of a Waku Web application Qaku. +The use of Waku protocols in the Qaku questions and +answers web application allow for a secure , trustless environment. ## Background Waku is a family of robust, censorship-resistant communication protocols designed to enable privacy-focused messaging for web3 apps. - -Qaku Q&A (Questions & Answers over Waku) -is an application allowing you to create a Q&A board, +Qaku is a questions and answers Waku web application. +It allows the user to create a Q&A board, share a link and let users post questions. Users can upvote questions which move to the top of the list on the board. @@ -44,15 +44,19 @@ The owner MUST be able to enable and disable questions added to the board. ### Node -- Qaku uses -[19/WAKU2-LIGHTPUSH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) +Qaku uses the following [10/WAKU]() protocols: + +- the [19/WAKU2-LIGHTPUSH](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/19/lightpush.md) to push a message type to the Waku network. +- the [12/WAKU2-FILTER]() to subscribe to Waku `content_topic` and listen to messages published to that topic. +- the [13/WAKU-STORE]() - A new `content_topic` is created when a new Q&A board is created. - All questions and answer are pushed to the content_topic ### Messages - -Messages sent on the `content_topic` are identified by their message type. -Message types in Qaku include: +The Waku network processes real-time message updates, which enables new questions and +answers to be acceisble quickly. +Messages sent to a `content_topic` are identified by a `message_type`. +The following `message_type`s used in Qaku include: - Question Message - Answered Message @@ -63,6 +67,8 @@ Message types in Qaku include: #### Question Message +The `QuestionMessage` is generated by any user asking a new question on a Qaku board. + ```js { "QuestionMessage" : [ @@ -77,6 +83,8 @@ Message types in Qaku include: #### Answered Message +The `Answer + ```js { "AnswerMessage" : [