diff --git a/deep-links/api-reference.md b/developer-guide/deep-links/api-reference.md similarity index 100% rename from deep-links/api-reference.md rename to developer-guide/deep-links/api-reference.md diff --git a/deep-links/guide.md b/developer-guide/deep-links/guide.md similarity index 100% rename from deep-links/guide.md rename to developer-guide/deep-links/guide.md diff --git a/deep-links/index.md b/developer-guide/deep-links/index.md similarity index 89% rename from deep-links/index.md rename to developer-guide/deep-links/index.md index e4ac686..35abb25 100644 --- a/deep-links/index.md +++ b/developer-guide/deep-links/index.md @@ -1,6 +1,6 @@ --- icon: link -expanded: true +expanded: false order: 999 --- diff --git a/deep-links/specification.md b/developer-guide/deep-links/specification.md similarity index 100% rename from deep-links/specification.md rename to developer-guide/deep-links/specification.md diff --git a/developer-guide/index.md b/developer-guide/index.md new file mode 100644 index 0000000..a680474 --- /dev/null +++ b/developer-guide/index.md @@ -0,0 +1,7 @@ +--- +icon: book +expanded: true +order: 500 +--- + +# Developer Guides diff --git a/wallet-connect/eip155/index.md b/developer-guide/wallet-connect/eip155/index.md similarity index 73% rename from wallet-connect/eip155/index.md rename to developer-guide/wallet-connect/eip155/index.md index 74782a9..947dca1 100644 --- a/wallet-connect/eip155/index.md +++ b/developer-guide/wallet-connect/eip155/index.md @@ -1,6 +1,6 @@ --- icon: link -expanded: true +expanded: false order: 999 --- diff --git a/wallet-connect/eip155/supportedMethods.md b/developer-guide/wallet-connect/eip155/supportedMethods.md similarity index 100% rename from wallet-connect/eip155/supportedMethods.md rename to developer-guide/wallet-connect/eip155/supportedMethods.md diff --git a/wallet-connect/guide.md b/developer-guide/wallet-connect/guide.md similarity index 100% rename from wallet-connect/guide.md rename to developer-guide/wallet-connect/guide.md diff --git a/wallet-connect/index.md b/developer-guide/wallet-connect/index.md similarity index 94% rename from wallet-connect/index.md rename to developer-guide/wallet-connect/index.md index 111f219..d840701 100644 --- a/wallet-connect/index.md +++ b/developer-guide/wallet-connect/index.md @@ -1,6 +1,6 @@ --- -icon: link -expanded: true +icon: broadcast +expanded: false order: 999 --- diff --git a/wallet-connect/supported.md b/developer-guide/wallet-connect/supported.md similarity index 100% rename from wallet-connect/supported.md rename to developer-guide/wallet-connect/supported.md diff --git a/wallet-connect/tip32/index.md b/developer-guide/wallet-connect/tip32/index.md similarity index 75% rename from wallet-connect/tip32/index.md rename to developer-guide/wallet-connect/tip32/index.md index 820db84..ab6af77 100644 --- a/wallet-connect/tip32/index.md +++ b/developer-guide/wallet-connect/tip32/index.md @@ -1,6 +1,6 @@ --- icon: link -expanded: true +expanded: false order: 999 --- diff --git a/static/screens/settings/change-password.png b/static/screens/settings/change-password.png new file mode 100644 index 0000000..6c74b55 Binary files /dev/null and b/static/screens/settings/change-password.png differ diff --git a/static/screens/settings/change-pin.png b/static/screens/settings/change-pin.png new file mode 100644 index 0000000..347005f Binary files /dev/null and b/static/screens/settings/change-pin.png differ diff --git a/static/screens/settings/currency.png b/static/screens/settings/currency.png new file mode 100644 index 0000000..ea14497 Binary files /dev/null and b/static/screens/settings/currency.png differ diff --git a/static/screens/settings/darkmode.png b/static/screens/settings/darkmode.png new file mode 100644 index 0000000..e3d0dc4 Binary files /dev/null and b/static/screens/settings/darkmode.png differ diff --git a/static/screens/settings/delete-profile.png b/static/screens/settings/delete-profile.png new file mode 100644 index 0000000..9f8362f Binary files /dev/null and b/static/screens/settings/delete-profile.png differ diff --git a/static/screens/settings/dev-mode.png b/static/screens/settings/dev-mode.png new file mode 100644 index 0000000..7d030c2 Binary files /dev/null and b/static/screens/settings/dev-mode.png differ diff --git a/static/screens/settings/download-time.png b/static/screens/settings/download-time.png new file mode 100644 index 0000000..4c03f75 Binary files /dev/null and b/static/screens/settings/download-time.png differ diff --git a/static/screens/settings/hidden-accounts.png b/static/screens/settings/hidden-accounts.png new file mode 100644 index 0000000..cd9096e Binary files /dev/null and b/static/screens/settings/hidden-accounts.png differ diff --git a/static/screens/settings/language.png b/static/screens/settings/language.png new file mode 100644 index 0000000..ac58e47 Binary files /dev/null and b/static/screens/settings/language.png differ diff --git a/static/screens/settings/lightmode.png b/static/screens/settings/lightmode.png new file mode 100644 index 0000000..0d9b852 Binary files /dev/null and b/static/screens/settings/lightmode.png differ diff --git a/static/screens/settings/logout.png b/static/screens/settings/logout.png new file mode 100644 index 0000000..c982b79 Binary files /dev/null and b/static/screens/settings/logout.png differ diff --git a/static/screens/settings/media-size.png b/static/screens/settings/media-size.png new file mode 100644 index 0000000..d4e21fa Binary files /dev/null and b/static/screens/settings/media-size.png differ diff --git a/static/screens/settings/profile-name.png b/static/screens/settings/profile-name.png new file mode 100644 index 0000000..b4d1257 Binary files /dev/null and b/static/screens/settings/profile-name.png differ diff --git a/static/screens/settings/refresh-nft.png b/static/screens/settings/refresh-nft.png new file mode 100644 index 0000000..ca7615a Binary files /dev/null and b/static/screens/settings/refresh-nft.png differ diff --git a/static/screens/settings/stronghold-lock.png b/static/screens/settings/stronghold-lock.png new file mode 100644 index 0000000..600d5b5 Binary files /dev/null and b/static/screens/settings/stronghold-lock.png differ diff --git a/user-guide/index.md b/user-guide/index.md new file mode 100644 index 0000000..0da6f41 --- /dev/null +++ b/user-guide/index.md @@ -0,0 +1,7 @@ +--- +icon: book +expanded: true +order: 999 +--- + +# User Guides diff --git a/user-guide/settings/advanced.md b/user-guide/settings/advanced.md new file mode 100644 index 0000000..32421ca --- /dev/null +++ b/user-guide/settings/advanced.md @@ -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! \ No newline at end of file diff --git a/user-guide/settings/collectibles.md b/user-guide/settings/collectibles.md new file mode 100644 index 0000000..2d8bb30 --- /dev/null +++ b/user-guide/settings/collectibles.md @@ -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. \ No newline at end of file diff --git a/user-guide/settings/general.md b/user-guide/settings/general.md new file mode 100644 index 0000000..1410b03 --- /dev/null +++ b/user-guide/settings/general.md @@ -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") +::: + + diff --git a/user-guide/settings/index.md b/user-guide/settings/index.md new file mode 100644 index 0000000..fa61df6 --- /dev/null +++ b/user-guide/settings/index.md @@ -0,0 +1,8 @@ +--- +icon: tools +expanded: false +order: 999 +--- + +# Settings + diff --git a/user-guide/settings/profile.md b/user-guide/settings/profile.md new file mode 100644 index 0000000..56055c0 --- /dev/null +++ b/user-guide/settings/profile.md @@ -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! \ No newline at end of file diff --git a/user-guide/settings/security.md b/user-guide/settings/security.md new file mode 100644 index 0000000..0be1e6a --- /dev/null +++ b/user-guide/settings/security.md @@ -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. +