status-im/status-desktop
2
0
Fork 0
mirror of https://github.com/status-im/status-desktop.git synced 2025-02-22 11:38:57 +00:00
Code Issues Projects Releases Wiki Activity

add other sections for main docs

Browse Source
This commit is contained in:
Iuri Matias 2021-05-07 15:56:39 -04:00
parent bcd1983c74
commit 5bc8629a41
32 changed files with 389 additions and 316 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
devuser_guide/.github/ISSUE_TEMPLATE/bug-report---.md vendored
View File

@ -1,25 +0,0 @@
---
name: "Bug report \U0001F41E"
about: Create a report to help us improve
---
## Description
Describe the issue that you're seeing.
### Steps to reproduce
Clear steps describing how to reproduce the issue. Please please please link to a demo project if possible, this makes your issue _much_ easier to diagnose (seriously).
### Expected result
What should happen?
### Actual result
What happened.
### Environment
Paste the information here as shown by `npm run check`

4
devuser_guide/.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -1,4 +0,0 @@
contact_links:
- name: Question 🙋
url: https://github.com/h-enk/doks/discussions/categories/q-a
about: Ask your question in Doks Discussions

17
devuser_guide/.github/ISSUE_TEMPLATE/feature-request---.md vendored
View File

@ -1,17 +0,0 @@
---
name: "Feature request \U0001F680"
about: Suggest an idea for Doks
---
## Summary
Brief explanation of the feature.
### Basic example
Include a basic example or links here.
### Motivation
Why are we doing this? What use cases does it support? What is the expected outcome?

11
devuser_guide/.github/dependabot.yml vendored
View File

@ -1,11 +0,0 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"

62
devuser_guide/.github/workflows/codeql-analysis.yml vendored
View File

@ -1,62 +0,0 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
name: "CodeQL"
on:
push:
branches: [master]
pull_request:
# The branches below must be a subset of the branches above
branches: [master]
schedule:
- cron: '0 11 * * 5'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
# Override automatic language detection by changing the below list
# Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
language: ['javascript']
# Learn more...
# https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
steps:
- name: Checkout repository
uses: actions/checkout@v2
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
#- run: |
# make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

48
devuser_guide/.github/workflows/node.js-ci.yml vendored
View File

@ -1,48 +0,0 @@
# Test and build your Hyas project
# For more information see: https://henkverlinde.com/continuous-integration-workflow-for-your-hyas-project/
name: Hyas CI
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
node-version: [14.x, 15.x]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Install Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: 'latest'
extended: true
- name: Check install Hugo
run: hugo version
- name: Install dependencies
run: npm ci
- name: Check for linting errors
run: npm test
- name: Delete temporary directories
run: npm run clean
- name: Build production website
run: npm run build

17
devuser_guide/.github/workflows/readme.yml vendored
View File

@ -1,17 +0,0 @@
name: Readme
on:
schedule:
- cron: 0 18 * * *
push:
branches:
- master
jobs:
update:
runs-on: ubuntu-latest
steps:
- uses: JasonEtco/rss-to-readme@v1
with:
feed-url: https://getdoks.org/blog/index.xml
readme-section: feed

24
devuser_guide/config/_default/menus.toml
View File

@ -4,18 +4,30 @@
identifier = "prologue"
url = "/docs/prologue/"
[[docs]]
name = "Test"
weight = 10
identifier = "test"
url = "/docs/test/"
[[docs]]
name = "Browser"
weight = 11
identifier = "browser"
url = "/docs/browser/"
[[docs]]
name = "Timelines"
weight = 11
identifier = "timelines"
url = "/docs/timelines/"
[[docs]]
name = "Chat"
weight = 11
identifier = "chat"
url = "/docs/chat/"
[[docs]]
name = "Wallet"
weight = 11
identifier = "wallet"
url = "/docs/wallet/"
[[dev]]
name = "Browser"
weight = 11

8
devuser_guide/content/dev_guide/browser/favourites.md
View File

@ -20,11 +20,11 @@ key source file: [`src/status/libstatus/browser.nim`](https://github.com/status-
key source file: [`src/app/browser/view.nim`](https://github.com/status-im/status-desktop/blob/d2b6bf9310df088c89abcca7c1df42abc3999b18/src/app/browser/view.nim#L46)
#### with the Star icon
### with the Star icon
key source file: [`ui/app/AppLayouts/Browser/BrowserHeader.qml`](https://github.com/status-im/status-desktop/blob/17b3a444589725f1723bda8549623e14a0277b2d/ui/app/AppLayouts/Browser/BrowserHeader.qml#L155)
#### with the Add favourite button
### with the Add favourite button
key source file: [`ui/app/AppLayouts/Browser/FavoritesList.qml`](https://github.com/status-im/status-desktop/blob/d2b6bf9310df088c89abcca7c1df42abc3999b18/ui/app/AppLayouts/Browser/FavoritesList.qml#L39)
@ -40,11 +40,11 @@ key source file: [`src/app/browser/view.nim`](https://github.com/status-im/statu
key source file: [`src/app/browser/views/bookmark_list.nim`](https://github.com/status-im/status-desktop/blob/17b3a444589725f1723bda8549623e14a0277b2d/src/app/browser/views/bookmark_list.nim#L5)
#### In the Toolbar
### In the Toolbar
key source file: [`ui/app/AppLayouts/Browser/FavoritesBar.qml`](https://github.com/status-im/status-desktop/blob/d2b6bf9310df088c89abcca7c1df42abc3999b18/ui/app/AppLayouts/Browser/FavoritesBar.qml#L12)
#### in the blank page
### In the blank page
key source file: [`ui/app/AppLayouts/Browser/BrowserLayout.qml`](https://github.com/status-im/status-desktop/blob/d2b6bf9310df088c89abcca7c1df42abc3999b18/ui/app/AppLayouts/Browser/BrowserLayout.qml#L670)

4
devuser_guide/content/docs/browser/favourites.md
View File

@ -18,7 +18,7 @@ toc: true
There are two ways to add a favourite.
#### Star icon
### Star icon
Click the star icon
![url_bar](/images/browser/url_bar.png)
@ -27,7 +27,7 @@ A dialog will open, confirm the details and click "Done"
![star_modal](/images/browser/star_modal.png)
#### Add favourite button
### Add favourite button
Another way to add a favourite is through the Add Favourite button in a blank tab
![add_favourite](/images/browser/add_favourite.png)

4
devuser_guide/content/docs/test/_index.md → devuser_guide/content/docs/chat/_index.md
View File

@ -1,6 +1,6 @@
---
title : "test"
description: "Docs Doks."
title : "Chat"
description: "Status Chat"
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00

20
devuser_guide/content/docs/chat/chat_list.md Normal file
View File

@ -0,0 +1,20 @@
---
title : "Chat List"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
## Search for a Chat
## Suggested Channels
## Badges
### unread message counter
### mentions @
## Context menu

20
devuser_guide/content/docs/chat/chats_general.md Normal file
View File

@ -0,0 +1,20 @@
---
title : "General"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
## Actions
### Mute a chat
### Mark as Read
### Fetch Messages
### Clear History
### leaving a chat

28
devuser_guide/content/docs/chat/communities.md Normal file
View File

@ -0,0 +1,28 @@
---
title : "Communities"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
## General
### Joining a community
### Creating a community
### Leaving a community
## Manage Community
### Creating Channels
#### Public Channels
#### Private Channels
### Transfer ownership
### Share Community
### See Members
### Kick Member
### Invite People
### Back up Community

20
devuser_guide/content/docs/chat/emojis_selector.md Normal file
View File

@ -0,0 +1,20 @@
---
title : "Emojis Selector"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
#### Choosing an emoji
#### Searching for an Emojis
#### Categories
#### See also
Text Input Box

20
devuser_guide/content/docs/chat/group_chats.md Normal file
View File

@ -0,0 +1,20 @@
---
title : "Group Chats"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
#### Starting a group chat
#### Group Information
#### Adding Members
#### Removing Members
#### Make other members admin
#### Renaming Group

21
devuser_guide/content/docs/chat/input_box.md Normal file
View File

@ -0,0 +1,21 @@
---
title : "Text Input Box"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
#### mentions
#### Emojis
#### code tags
#### markdown
#### Text Formatter
#### Sending file attachments
#### special commands (e.g /shrug)

25
devuser_guide/content/docs/chat/messages.md Normal file
View File

@ -0,0 +1,25 @@
---
title : "Messages"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
## Normal Messages
## Stickers
## Images
## URL Unfurling
### Enable Unfurling
## Reactions
## Replying to messages
## profile options
### view profile
### send message

16
devuser_guide/content/docs/chat/notifications.md Normal file
View File

@ -0,0 +1,16 @@
---
title : "Notifications"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
## notification types
## notification settings

23
devuser_guide/content/docs/chat/one_on_one.md Normal file
View File

@ -0,0 +1,23 @@
---
title : "1 on 1 Chats"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
## sending images
## transactions
### send transaction
### request payment
## start new 1 on 1 Chat
### with existing contact
### by ENS username
### by chat key
## join or start a public chat

19
devuser_guide/content/docs/chat/stickers.md Normal file
View File

@ -0,0 +1,19 @@
---
title : "Stickers"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "chat"
toc: true
---
## Choosing a Sticker
### Recently used Stickers
### Sticker collections
## Getting free Stickers
## Buying a sticker pack

118
devuser_guide/content/docs/test/test2.md
View File

@ -1,118 +0,0 @@
---
title: "test25"
description: "Doks comes with commands for common tasks."
lead: "Doks comes with commands for common tasks."
date: 2020-10-13T15:21:01+02:00
lastmod: 2020-10-13T15:21:01+02:00
draft: false
images: []
menu:
docs:
parent: "test"
weight: 130
toc: true
---
{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." >}}
## create
Create new content for your site:
{{< btn-copy text="npm run create" >}}
```bash
npm run create [path] [flags]
```
See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/).
## lint
Check scripts, styles, and markdown for errors:
{{< btn-copy text="npm run lint" >}}
```bash
npm run lint
```
### scripts
Check scripts for errors:
{{< btn-copy text="npm run lint:scripts" >}}
```bash
npm run lint:scripts [-- --fix]
```
### styles
Check styles for errors:
{{< btn-copy text="npm run lint:styles" >}}
```bash
npm run lint:styles [-- --fix]
```
### markdown
Check markdown for errors:
{{< btn-copy text="npm run lint:markdown" >}}
```bash
npm run lint:markdown [-- --fix]
```
## clean
Delete temporary directories:
{{< btn-copy text="npm run clean" >}}
```bash
npm run clean
```
## start
Start local development server:
{{< btn-copy text="npm run start" >}}
```bash
npm run start
```
## build
Build production website:
{{< btn-copy text="npm run build" >}}
```bash
npm run build
```
### functions
Build Lambda functions:
{{< btn-copy text="npm run build:functions" >}}
```bash
npm run build:functions
```
### preview
Build production website including draft and future content:
{{< btn-copy text="npm run build:preview" >}}
```bash
npm run build:preview
```

10
devuser_guide/content/docs/timelines/_index.md Normal file
View File

@ -0,0 +1,10 @@
---
title : "Timelines"
description: "Status Timelines"
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
---

13
devuser_guide/content/docs/timelines/posting_updates.md Normal file
View File

@ -0,0 +1,13 @@
---
title : "Posting Updates"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "timelines"
toc: true
---

19
devuser_guide/content/docs/timelines/viewing_updates.md Normal file
View File

@ -0,0 +1,19 @@
---
title : "Seeing Updates"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "timelines"
toc: true
---
## viewing updates
## fetching more updates
## default when there are no updates

10
devuser_guide/content/docs/wallet/_index.md Normal file
View File

@ -0,0 +1,10 @@
---
title : "Wallet"
description: "Status Wallet"
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
---

18
devuser_guide/content/docs/wallet/account_details.md Normal file
View File

@ -0,0 +1,18 @@
---
title : "Account Details & Balances"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "wallet"
toc: true
---
## Assets
## Collectibles
## History
## Editing Account name & color

14
devuser_guide/content/docs/wallet/account_list.md Normal file
View File

@ -0,0 +1,14 @@
---
title : "Accounts List"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "wallet"
toc: true
---

18
devuser_guide/content/docs/wallet/adding_accounts.md Normal file
View File

@ -0,0 +1,18 @@
---
title : "Adding Accounts"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "wallet"
toc: true
---
## Generating an account
## Adding a watch only address
## Adding an account using a seed phrase
## Adding an account using a private key

14
devuser_guide/content/docs/wallet/receiving_funds.md Normal file
View File

@ -0,0 +1,14 @@
---
title : "Receiving Funds"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "wallet"
toc: true
---

16
devuser_guide/content/docs/wallet/sending_funds.md Normal file
View File

@ -0,0 +1,16 @@
---
title : "Sending funds"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "wallet"
toc: true
---
## Choosing Recipient
## Choosing Amounts, Token, gas values

19
devuser_guide/content/docs/wallet/wallet_settings.md Normal file
View File

@ -0,0 +1,19 @@
---
title : "Wallet settings"
description: ""
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
draft: false
images: []
menu:
docs:
parent: "wallet"
toc: true
---
## Changing currency
## Managing Tokens
### Enabling Tokens
### Disabling Tokens
### Add custom Tokens