status-im/status-desktop
2
0
Fork 0
mirror of https://github.com/status-im/status-desktop.git synced 2025-02-02 17:54:01 +00:00
Code Issues Projects Releases Wiki Activity

document chat & wallet functionality

Browse Source
This commit is contained in:
Iuri Matias 2021-06-01 16:58:43 -04:00
parent 212399f230
commit 0b44117dda
7 changed files with 164 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
devuser_guide/content/dev_guide/chat/chats_general.md
View File

@ -13,8 +13,41 @@ toc: true
---
## Actions
### Finding actions
- [`ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml#L8)
#### Context menu
- [`ui/app/AppLayouts/Chat/ContactsColumn/Channel.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/ContactsColumn/Channel.qml#L192)
#### Popover menu
- [`ui/app/AppLayouts/Chat/ChatColumn/TopBar.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/ChatColumn/TopBar.qml#L97)
### Mute a chat
- [`ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml#L81)
- [`src/app/chat/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/chat/view.nim#L792)
- [`src/status/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/chat.nim#L432)
- [`src/status/libstatus/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/chat.nim#L254)
### Mark as Read
- [`ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml#L97)
- [`src/app/chat/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/chat/view.nim#L342)
- [`src/status/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/chat.nim#L381)
- [`src/status/libstatus/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/chat.nim#L217)
### Fetch Messages
- [`ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml#L100)
currently disabled
### Clear History
- [`ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml#L107)
- [`src/app/chat/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/chat/view.nim#L706)
- [`src/status/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/chat.nim#L269)
- [`src/status/libstatus/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/chat.nim#L229)
### leaving a chat
- [`ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Chat/components/ChannelContextMenu.qml#L137)
- [`src/app/chat/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/chat/view.nim#L667)
- [`src/status/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/chat.nim#L255)
- [`src/status/libstatus/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/chat.nim#L46)

23
devuser_guide/content/dev_guide/chat/communities.md
View File

@ -39,20 +39,41 @@ toc: true
#### selecting a community
- [`ui/app/AppLayouts/Chat/CommunityComponents/CommunitiesPopup.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/CommunitiesPopup.qml#L212)
- [`src/app/chat/view.nim`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/src/app/chat/view.nim#L166)
- [`src/app/chat/views/communities.nim`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/src/app/chat/views/communities.nim#L146)
- [`src/app/chat/views/community_item.nim`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/src/app/chat/views/community_item.nim#L40)
#### joining a community
- [`ui/app/AppLayouts/Chat/ContactsColumn.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/ContactsColumn.qml#L85)
- [`ui/app/AppLayouts/Chat/CommunityComponents/CommunityDetailPopup.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/CommunityDetailPopup.qml#L243)
- [`src/app/chat/views/communities.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/chat/views/communities.nim#L381)
- [`src/status/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/chat.nim#L524)
- [`src/status/libstatus/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/chat.nim#L434)
### Creating a community
- [`ui/app/AppLayouts/Chat/CommunityComponents/CommunitiesPopup.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/CommunitiesPopup.qml#L230)
- [`ui/app/AppLayouts/Chat/ContactsColumn.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/ContactsColumn.qml#L67)
- [`ui/app/AppLayouts/Chat/CommunityComponents/CreateCommunityPopup.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/CreateCommunityPopup.qml#L438)
- [`src/app/chat/views/communities.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/chat/views/communities.nim#L214)
- [`src/status/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/chat.nim#L472)
- [`src/status/libstatus/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/chat.nim#L292)
#### uploading a thumbnail image
// TODO: describe choosing file dialog, cropping image, uploading image
#### setting community color
- [`ColorDialog QML Type`](https://doc.qt.io/qt-5/qml-qtquick-dialogs-colordialog.html)
- [`ui/app/AppLayouts/Chat/CommunityComponents/CreateCommunityPopup.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/CreateCommunityPopup.qml#L323)
#### setting membership requirement
- [`ui/app/AppLayouts/Chat/CommunityComponents/CreateCommunityPopup.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/CreateCommunityPopup.qml#L350)
- [`ui/app/AppLayouts/Chat/CommunityComponents/MembershipRequirementPopup.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/MembershipRequirementPopup.qml#L9)
### Leaving a community
- [`ui/app/AppLayouts/Chat/CommunityComponents/CommunityList.qml`](https://github.com/status-im/status-desktop/blob/358091a8eb19f36c9843b42d61473e35ea87d05b/ui/app/AppLayouts/Chat/CommunityComponents/CommunityList.qml#L68)
- [`src/app/chat/views/communities.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/chat/views/communities.nim#L318)
- [`src/status/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/chat.nim#L503)
- [`src/status/libstatus/chat.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/chat.nim#L416)
## Manage Community

30
devuser_guide/content/dev_guide/chat/input_box.md
View File

@ -12,10 +12,26 @@ menu:
toc: true
---
#### mentions
#### Emojis
#### code tags
#### markdown
#### Text Formatter
#### Sending file attachments
#### special commands (e.g /shrug)
## mentions
## Emojis
## code tags
## Text Formatter
### markdown
### bold
### italic
### strikethrough
### code
## Sending file attachments
## special commands (e.g /shrug)
- [`ui/shared/status/StatusChatInput.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/shared/status/StatusChatInput.qml#L81)

28
devuser_guide/content/dev_guide/wallet/account_details.md
View File

@ -12,7 +12,33 @@ menu:
toc: true
---
## Tabs
- [`ui/app/AppLayouts/Wallet/WalletLayout.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/WalletLayout.qml#L127)
## Assets
- [`ui/app/AppLayouts/Wallet/AssetsTab.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/AssetsTab.qml#L96)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L367)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L322)
- [`src/status/wallet/account.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/wallet/account.nim#L22)
- [`src/status/wallet.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/wallet.nim#L193)
## Collectibles
- [`ui/app/AppLayouts/Wallet/CollectiblesTab.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/CollectiblesTab.qml#L48)
## account with collectibles
### account without known collectibles
- [`ui/app/AppLayouts/Wallet/CollectiblesTab.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/CollectiblesTab.qml#L37)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L293)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L566)
## History
## Editing Account name & color
- [`ui/app/AppLayouts/Wallet/HistoryTab.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/HistoryTab.qml#L229)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L307)
- [`src/app/wallet/views/transaction_list.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/views/transaction_list.nim#L21)
// TODO: needs more detail
## Editing Account name & color
- [`ui/app/AppLayouts/Wallet/AccountSettingsModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/AccountSettingsModal.qml#L181)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L437)

29
devuser_guide/content/dev_guide/wallet/adding_accounts.md
View File

@ -12,7 +12,28 @@ menu:
toc: true
---
## Generating an account
## Adding a watch only address
## Adding an account using a seed phrase
## Adding an account using a private key
// TODO: needs more detail, specially about the backend
## Adding an Account
- [`ui/app/AppLayouts/Wallet/LeftTab.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/LeftTab.qml#L66)
- [`ui/app/AppLayouts/Wallet/components/AddAccount.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/components/AddAccount.qml#L7)
### Generating an account
- [`ui/app/AppLayouts/Wallet/components/GenerateAccountModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/components/GenerateAccountModal.qml#L103)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L416)
- [`src/status/wallet.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/wallet.nim#L251)
### Adding a watch only address
- [`ui/app/AppLayouts/Wallet/components/AddWatchOnlyAccount.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/components/AddWatchOnlyAccount.qml#L103)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L434)
- [`src/status/wallet.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/wallet.nim#L295)
### Adding an account using a seed phrase
- [`ui/app/AppLayouts/Wallet/components/AddAccountWithSeed.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/components/AddAccountWithSeed.qml#L131)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L422)
- [`src/status/wallet.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/wallet.nim#L271)
### Adding an account using a private key
- [`ui/app/AppLayouts/Wallet/components/AddAccountWithPrivateKey.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/components/AddAccountWithPrivateKey.qml#L129)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L428)
- [`src/status/wallet.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/wallet.nim#L284)

20
devuser_guide/content/dev_guide/wallet/receiving_funds.md
View File

@ -12,3 +12,23 @@ menu:
toc: true
---
## receiving funds on an account
### modal
- [`ui/app/AppLayouts/Wallet/WalletHeader.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/WalletHeader.qml#L136)
- [`ui/app/AppLayouts/Wallet/ReceiveModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/ReceiveModal.qml#L6)
### QR Code
- [`ui/app/AppLayouts/Wallet/ReceiveModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/ReceiveModal.qml#L53)
- [`src/app/profile/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/profile/view.nim#L130)
- [`src/app/profile/qrcode`](https://github.com/status-im/status-desktop/tree/master/src/app/profile/qrcode)
### listing accounts
- [`ui/app/AppLayouts/Wallet/ReceiveModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/ReceiveModal.qml#L43)
- [`ui/shared/AccountSelector.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/shared/AccountSelector.qml#L119)
- [`src/status/wallet.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/wallet.nim#L214)
- [`src/status/libstatus/wallet.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/status/libstatus/wallet.nim#L9)
- [`src/app/wallet/view.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/view.nim#L234)
- [`src/app/wallet/views/account_list.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/views/account_list.nim#L23)
- [`src/app/wallet/core.nim`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/src/app/wallet/core.nim#L33)

14
devuser_guide/content/dev_guide/wallet/sending_funds.md
View File

@ -12,5 +12,19 @@ menu:
toc: true
---
## Sending funds
- [`ui/app/AppLayouts/Wallet/WalletHeader.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/WalletHeader.qml#L125)
- [`ui/app/AppMain.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppMain.qml#L289)
- [`ui/app/AppLayouts/Wallet/SendModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/SendModal.qml#L10)
## Choosing Recipient
- [`ui/app/AppLayouts/Wallet/SendModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/SendModal.qml#L56)
// TODO: Add section for shared components like AccountSelector
- [`ui/app/AppLayouts/Wallet/SendModal.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/app/AppLayouts/Wallet/SendModal.qml#L77)
- [`ui/shared/RecipientSelector.qml`](https://github.com/status-im/status-desktop/blob/af2ec66e0c7912baad871aea34efcc493e02de27/ui/shared/RecipientSelector.qml#L7)
## Choosing Amounts, Token, gas values
// TODO