docs: add some docs for new features in rotki 1.37

rotki · Dec 12, 2024 · d3e2447 · d3e2447
1 parent 26da515
commit d3e2447
Show file tree

Hide file tree

Showing 17 changed files with 36 additions and 16 deletions.
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -63,6 +63,7 @@ export default defineConfig({
           { text: 'Adding missing prices', link: '/usage-guides/custom-price' },
           { text: 'Decentralized Finance', link: '/usage-guides/decentralized-finance' },
           { text: 'Creating a profit/loss report', link: '/usage-guides/pnl' },
+          { text: 'Tag Management', link: '/usage-guides/tag-management' },
           { text: 'Statistic', link: '/usage-guides/statistic' },
           { text: 'Global Search', link: '/usage-guides/global-search' },
           { text: 'Taking Notes In-App', link: '/usage-guides/user-notes' },

diff --git a/public/images/add_etherscan_keys.png b/public/images/add_etherscan_keys.png
diff --git a/public/images/add_tag.png b/public/images/add_tag.png
diff --git a/public/images/add_tag_label.png b/public/images/add_tag_label.png
diff --git a/public/images/external_services.png b/public/images/external_services.png
diff --git a/public/images/hide_small_balances.png b/public/images/hide_small_balances.png
diff --git a/public/images/loopring_add_key.png b/public/images/loopring_add_key.png
diff --git a/public/images/monerium_add_key.png b/public/images/monerium_add_key.png
diff --git a/public/images/rotki_add_calendar_event.png b/public/images/rotki_add_calendar_event.png
diff --git a/public/images/rotki_calendar.png b/public/images/rotki_calendar.png
diff --git a/public/images/sc_amount_settings.png b/public/images/sc_amount_settings.png
diff --git a/public/images/tag_manager.png b/public/images/tag_manager.png
diff --git a/usage-guides/accounts-and-balances.md b/usage-guides/accounts-and-balances.md
@@ -126,12 +126,6 @@ You can also filter the manual balances by `location`, `name` or `asset`.
 
 ![The manually tracked balances](/images/sc_manually_tracked_balances.png)
 
-## Adding/Editing Labels and tags
-
-You can edit any of your blockchain accounts and add a label. The label is unique to the account and will show up in the accounts tables instead of the address. You will still be able to see the address if you hover over the label in the tables.
-
-![Add a label and create a tag](/images/add_tag_label.png)
-
 By pressing the edit button for the account you can also add tags to the blockchain account. If you want to create a new tag or edit an existing one you can open the tag manager and choose the name, description and colors of the tag.
 
 ## Filtering by tags
@@ -142,6 +136,17 @@ You can filter the tables by a combination of tags.
 
 Simply add the tags you wish to filter by in the filter textbox above the tables.
 
+## Hide small balances
+
+You can filter out small balances and set the threshold yourself.
+
+By default, this setting will apply to all balance types (blockchain balances, exchange balances, and manual balances).
+You can uncheck the checkbox to apply the setting only to the current balances view.
+
+> Note: you need to press "Apply Changes" for the setting to take effect.
+
+![Hide small balances](/images/hide_small_balances.png)
+
 ## Loopring balances
 
 From the balances section you can quickly get an overview of the accounts having balances in Loopring and what assets these accounts hold.

diff --git a/usage-guides/calendar.md b/usage-guides/calendar.md
@@ -2,6 +2,8 @@
 
 rotki provides a calendar view where you can add and track events for your activities. You can also set reminders to perform some actions related to these events.
 
+You can see today's selected events and upcoming events on the right pane.
+
 ![Calendar view](/images/rotki_calendar.png)
 
 ![Add calendar event](/images/rotki_add_calendar_event.png)

diff --git a/usage-guides/customization.md b/usage-guides/customization.md
@@ -84,6 +84,14 @@ Choose the "User & Security" section to change the user password.
 
 > Set the symbol separating the floating part of a number, e.g., `5.42`.
 
+### Subscript Format
+
+> Whether to apply subscript formatting for consecutive zeros after the decimal point in small numbers, e.g., `0.000000087` => `0.0₇87`.
+
+#### Amount Rounding
+
+> Choose the rounding mechanism: `Round up`, `Round down`, or `Half even`. Customize how amounts and values are rounded.
+
 #### Abbreviation for large numbers
 
 > If enabled, large numbers will be abbreviated, e.g., `1,234,567` as `1.23 M`. Set the minimum value to be abbreviated.
@@ -92,10 +100,6 @@ Choose the "User & Security" section to change the user password.
 
 > Set whether the currency symbol appears before or after the number, e.g., `$1,000` or `1,000$`.
 
-#### Amount Rounding
-
-> Choose the rounding mechanism: `Round up`, `Round down`, or `Half even`. Customize how amounts and values are rounded.
-
 ### NFT Settings
 
 ![Customizing the app's NFT settings](/images/sc_nf_settings.png)

diff --git a/usage-guides/importing-data.md b/usage-guides/importing-data.md
@@ -80,12 +80,12 @@ rotki relies on various external services for data such as historical crypto pri
 
 Go to `API Keys → External Services`.
 
+![External services](/images/external_services.png)
+
 ### Etherscan
 
 At the moment, there is no compulsory API key. But if you don't use your own node, Etherscan queries without an API key are really slow. So if you don't already have an account with them, please create one [here](https://etherscan.io/register) and then generate a free API key and set it in the app as explained above. It's free of charge.
 
-![Add Etherscan keys](/images/add_etherscan_keys.png)
-
 ### Loopring balances
 
 To have your Loopring balances detected, you will need an API Key from Loopring. To get one, visit [Loopring Security](https://loopring.io/#/layer2/security) and unlock your account. In the list of options, click on **Export Account**.
@@ -94,8 +94,6 @@ To have your Loopring balances detected, you will need an API Key from Loopring.
 
 Then in rotki, you need to add the API key in the `Loopring` section.
 
-![Add Loopring key](/images/loopring_add_key.png)
-
 After following these steps, your balances in the dashboard will be updated including the Loopring information.
 
 ![Loopring balances in the UI](/images/loopring_balances.png)
@@ -111,8 +109,6 @@ As long as you provide Monerium credentials, all Monerium transactions on Mainne
 
 > **Note**: Monerium API can only use basic authentication at the moment. We are in contact with their team and they will add API keys eventually. But for now, they only have basic authentication, which means your username and password are stored in rotki (encrypted). Take necessary security precautions and don't use unless you understand the potential risks.
 
-![Add Monerium](/images/monerium_add_key.png)
-
 ### Gnosis Pay
 
 You can integrate Gnosis Pay with rotki to import your transaction data. Note that this feature is **experimental** and is only available for premium users.

diff --git a/usage-guides/tag-management.md b/usage-guides/tag-management.md
@@ -0,0 +1,12 @@
+# Tag Management
+
+You can find the menu on the left sidebar.
+
+![Tag Manager](/images/tag_manager.png)
+
+## Adding/Editing Labels and tags
+
+You can add or edit tags from this view. You can also create a new tag when you are adding your blockchain account or manual balance.
+The label is unique, so you can't create multiple tags with the same label.
+
+![Create a tag](/images/add_tag.png)