adding documentation

This commit is contained in:
Richard Ramos 2021-05-18 09:31:18 -04:00 committed by Iuri Matias
parent 872aa7794c
commit f7a3be7c04
9 changed files with 38 additions and 0 deletions

View File

@ -20,6 +20,22 @@ toc: true
### Creating Channels ### Creating Channels
#### Public Channels #### Public Channels
#### Private Channels #### Private Channels
### Categories
key source file: [`ui/app/AppLayouts/Chat/CommunityComponents/CategoryList.qml`](https://github.com/status-im/status-desktop/blob/3f56db35bac7cc3b0f3769ef1afbd5060b10d03f/ui/app/AppLayouts/Chat/CommunityComponents/CategoryList.qml)
key source file: [`ui/app/AppLayouts/Chat/CommunityComponents/CreateCategoryPopup.qml`](https://github.com/status-im/status-desktop/blob/e5b42b3fb568b955fb05fbf34673aec0eb5adda8/ui/app/AppLayouts/Chat/CommunityComponents/CreateCategoryPopup.qml)
key source file: [`src/app/chat/views/category_list.nim`](https://github.com/status-im/status-desktop/blob/3f56db35bac7cc3b0f3769ef1afbd5060b10d03f/src/app/chat/views/category_list.nim)
key source file: [`src/app/chat/views/communities.nim`](https://github.com/status-im/status-desktop/blob/3f56db35bac7cc3b0f3769ef1afbd5060b10d03f/src/app/chat/views/communities.nim)
key source file: [`src/app/chat/views/communities.nim`](https://github.com/status-im/status-desktop/blob/3f56db35bac7cc3b0f3769ef1afbd5060b10d03f/src/app/chat/views/communities.nim)
status-go: [Community categories #2228](https://github.com/status-im/status-go/pull/2228)
Channels within a community might be organized in categories. Only the community admin might create/edit/delete a category. An admin can create/edit a category and add channels to it as long as those categories have not been assigned before (`categoryId == ""`). Deleting a category will remove the `categoryId` from any chat assigned to the category being deleted. Creating a channel in a category works by calling `wakuext_reorderCommunityChat` after the chat is created, then the `Chat` is immediatly assigned a `categoryId`.
### Transfer ownership ### Transfer ownership
### Share Community ### Share Community
### See Members ### See Members

View File

@ -62,6 +62,26 @@ toc: true
![url_bar](/images/communities/new_channel.png) ![url_bar](/images/communities/new_channel.png)
### Creating Categories
![url_bar](/images/communities/category_menu.png)
![url_bar](/images/communities/category_popup.png)
![url_bar](/images/communities/category_list.png)
### Editing Categories
![url_bar](/images/communities/category_menu_context.png)
![url_bar](/images/communities/category_popup_edit.png)
### Delete Categories
![url_bar](/images/communities/category_menu_context.png)
![url_bar](/images/communities/category_delete_confirm.png)
### Transfer ownership ### Transfer ownership
![url_bar](/images/communities/transfer_ownership.png) ![url_bar](/images/communities/transfer_ownership.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -135,6 +135,7 @@ ModalPopup {
Separator { Separator {
id: sep2 id: sep2
visible: isEdit
anchors.left: parent.left anchors.left: parent.left
anchors.right: parent.right anchors.right: parent.right
anchors.top: communityChannelList.bottom anchors.top: communityChannelList.bottom
@ -145,6 +146,7 @@ ModalPopup {
Item { Item {
id: deleteCategory id: deleteCategory
visible: isEdit
anchors.top: sep2.bottom anchors.top: sep2.bottom
anchors.topMargin: Style.current.padding anchors.topMargin: Style.current.padding
width: deleteBtn.width + deleteTxt.width + Style.current.padding width: deleteBtn.width + deleteTxt.width + Style.current.padding