Skip to content

Commit

Permalink
add settings guides
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkNerdi committed Nov 27, 2023
1 parent a6c1376 commit 8d347d7
Show file tree
Hide file tree
Showing 33 changed files with 189 additions and 5 deletions.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
icon: link
expanded: true
expanded: false
order: 999
---

Expand Down
File renamed without changes.
7 changes: 7 additions & 0 deletions developer-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
icon: book
expanded: true
order: 500
---

# Developer Guides
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
icon: link
expanded: true
expanded: false
order: 999
---

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
icon: link
expanded: true
icon: broadcast
expanded: false
order: 999
---

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
icon: link
expanded: true
expanded: false
order: 999
---

Expand Down
Binary file added static/screens/settings/change-password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/change-pin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/currency.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/darkmode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/delete-profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/dev-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/download-time.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/hidden-accounts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/language.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/lightmode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/logout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/media-size.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/profile-name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/refresh-nft.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/screens/settings/stronghold-lock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions user-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
icon: book
expanded: true
order: 999
---

# User Guides
20 changes: 20 additions & 0 deletions user-guide/settings/advanced.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
icon: code-square
order: 1
---

# Advanced

### Hidden Accounts
:::image
![](../../static/screens/settings/hidden-accounts.png "Hidden accounts")
:::
By enabling this setting, accounts you previously hid with the `Hide account` functionality (reference to guide TODO), are again displayed across your wallet.

### Developer Mode
:::image
![](../../static/screens/settings/dev-mode.png "Developer Mode")
:::

By enabling the developer mode, you get access to the `Developer` tab in the menu sidebar (reference to developer tools guide TODO).
**Keep in mind** that the `Developer tools` are implemented for developers to test NFTs, native tokens etc. If you intend to launch a NFT campain or something similar, we recommend using external tools!
30 changes: 30 additions & 0 deletions user-guide/settings/collectibles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
icon: image
order: 100
---

# Collectibles

### Maximum download time
:::image
![](../../static/screens/settings/download-time.png "Download time")
:::

NFTs can contain a large amount of data that can take a very long time to download. Downloads happen sequentially, which means that if the first downloaded NFT takes too long, the next NFTs are not downloaded until the first is finished.
If an NFT isn't downloaded because of this setting, you're still able to see the NFT by using the `Open media in browser` button.


### Maximum media size
:::image
![](../../static/screens/settings/media-size.png "Media size")
:::

NFTs can contain a large amount of data, e.g. high resolution videos. Because Bloom stores all NFT media locally, it is recommended to set a upper limit for the media size, so that they don't take up too much space on your computer.
If an NFT isn't downloaded because of this setting, you're still able to see the NFT by using the `Open media in browser` button.

### Refresh NFT media
:::image
![](../../static/screens/settings/refresh-nft.png "Refresh NFT")
:::

Sometimes it can happen that NFT media is downloaded incorrectly. If you suspect that something is wrong in your `Collectibles` tab, you can use the `Refresh` button to try to fix it.
35 changes: 35 additions & 0 deletions user-guide/settings/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
icon: info
order: 999
---

# General
These settings are applied to the **whole** application, across all profiles and wallets.

### Theme
Specifies the app's theme.

##### Light mode:
:::image
![](../../static/screens/settings/lightmode.png "Lightmode")
:::


##### Dark mode:
:::image
![](../../static/screens/settings/darkmode.png "Darkmode")
:::

##### System mode:
The theme specified in your operating system's settings is applied to Bloom.


### Language
Specifies the language used across Bloom. If you cannot find your preferred language in Bloom's list, you can help us translating.
Join our [Discord](https://discord.com/invite/RjX3jEc7K7) and take a look in our `🔡-translations` [channel](https://discord.com/channels/1106530660358828062/1174373868203425863)

:::image
![](../../static/screens/settings/language.png "Language picker")
:::


8 changes: 8 additions & 0 deletions user-guide/settings/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
icon: tools
expanded: false
order: 999
---

# Settings

31 changes: 31 additions & 0 deletions user-guide/settings/profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
icon: person
order: 500
---

# Profile
In this section you will find settings relevant for the whole profile, overarching all wallets.

### Profile name
:::image
![](../../static/screens/settings/profile-name.png "Profile Name")
:::

This is used to customize your profile. The profile name helps you identifying the correct profile if you have multiple seed phrases registered in your Bloom wallet.


### Currency
:::image
![](../../static/screens/settings/currency.png "Currency")
:::

With this setting you dictate which currency is used across the whole app if Bloom displays the fiat value for an asset.


### Delete profile
:::image
![](../../static/screens/settings/delete-profile.png "Delete Profile")
:::

Deleting a profile means that you will not be able to access it afterwards. This will remove the profile from the profile selection and all its files and data.
**Important**: This action is irreversible. If you don't have access to your seed phrase or to a recent `.stronghold` file, you will lose access to your funds. Make sure to double check on the avaiability to those beforehand!
46 changes: 46 additions & 0 deletions user-guide/settings/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
icon: lock
order: 300
---

# Security

This section includes relevant settings to make your wallet use more secure.

### Profile
If a third person gets access to your computer and they know your PIN, they can log in to your profile.
**Important**: Even though they know the PIN, they are not able to interact with your balance and NFTs.

#### Automatic logout
:::image
![](../../static/screens/settings/logout.png "Automatic Logout")
:::

If you have your wallet installed on a computer where people can access it while your away, and you want to keep your privacy, set the `Automatic Logout` to `1-5 minutes`.

#### Change PIN
:::image
![](../../static/screens/settings/change-pin.png "Change Pin")
:::

If you suspect that a third person has received access to your PIN, change it ASAP to keep your profile private.


### Stronghold
Stronghold is the technology Bloom uses to securly store your seed phrase. To use the seed phrase to e.g. sign transactions, the password is required.
**Important**: Keep your password safe so that only you can access your funds! If a third person gets access to it, your funds may be in danger.

#### Stronhold timeout
:::image
![](../../static/screens/settings/stronghold-lock.png "Stronghold Lock")
:::

If you have your wallet installed on a computer where people can access it while your away, it is recommended to set your `Stronghold timeout` to a short amount, i.e `1-5 minutes`.

##### Change Password
:::image
![](../../static/screens/settings/change-password.png "Change Password")
:::

If you suspect that a third person has received access to your password, change it ASAP to minimize risk.

0 comments on commit 8d347d7

Please sign in to comment.