Skip to content

Commit

Permalink
Merge branch 'bugfixes' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
kelsos committed Nov 5, 2024
2 parents fcd9621 + 34621e2 commit 88597b1
Show file tree
Hide file tree
Showing 23 changed files with 107 additions and 103 deletions.
16 changes: 8 additions & 8 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const base = isLatest || isPatch ? `/${DOCS_VERSION}` : '/';

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: 'Rotki Documentation',
title: 'rotki Documentation',
base,
description: 'All you need to start using rotki, or contributing to it.',
themeConfig: {
Expand Down Expand Up @@ -45,7 +45,7 @@ export default defineConfig({
{
text: 'System Requirements & Installation',
items: [
{ text: 'Introduction', link: '/requirement-and-installation' },
{ text: 'Introduction', link: '/requirement-and-installation/' },
{ text: 'Packaged Binaries', link: '/requirement-and-installation/packaged-binaries' },
{ text: 'Build From Source', link: '/requirement-and-installation/build-from-source' },
],
Expand Down Expand Up @@ -73,7 +73,7 @@ export default defineConfig({
text: 'Advanced',
items: [
{ text: 'Set the backend\'s arguments', link: '/usage-guides/backend-arguments' },
{ text: 'Rotki data directory', link: '/usage-guides/data-directory' },
{ text: 'rotki data directory', link: '/usage-guides/data-directory' },
{ text: 'Accessing the database manually', link: '/usage-guides/accessing-db-manually' },
{ text: 'Long running tasks', link: '/usage-guides/long-running-tasks' },
{ text: 'Using rotki from mobile', link: '/usage-guides/using-rotki-from-mobile' },
Expand All @@ -83,16 +83,16 @@ export default defineConfig({
{
text: 'Frequently Asked Questions',
items: [
{ text: 'Application', link: 'faq#questions-on-the-application' },
{ text: 'Premium', link: 'faq#questions-on-premium' },
{ text: 'Roadmap & Features', link: 'faq#questions-on-roadmap-and-features' },
{ text: 'Miscellaneous', link: 'faq#miscellaneous-questions' },
{ text: 'Application', link: '/faq#questions-on-the-application' },
{ text: 'Premium', link: '/faq#questions-on-premium' },
{ text: 'Roadmap & Features', link: '/faq#questions-on-roadmap-and-features' },
{ text: 'Miscellaneous', link: '/faq#miscellaneous-questions' },
],
},
{
text: 'Contribution Guides',
items: [
{ text: 'Bug Reporting', link: '/contribution-guides' },
{ text: 'Bug Reporting', link: '/contribution-guides/' },
{ text: 'Feature Requests', link: '/contribution-guides/feature-requests' },
{ text: 'Contributing as a Developer', link: '/contribution-guides/contribute-as-developer' },
{ text: 'Working on Issues', link: '/contribution-guides/working-on-issues' },
Expand Down
4 changes: 4 additions & 0 deletions .vitepress/theme/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,7 @@
.VPButton.medium {
border-radius: 0.5rem !important;
}

.main .name .clip {
font-size: 1.25em;
}
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.

Copyright (C) 2017-2020 Karapetsas Eleftherios
Copyright (C) 2020-2022 Rotki Solutions GmbH
Copyright (C) 2020-2024 Rotki Solutions GmbH

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
Expand Down
4 changes: 2 additions & 2 deletions contribution-guides/contribute-as-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,9 +276,9 @@ The `countries` field will be used to show the country's flag on the app. You ca

### Add or edit a translation

Rotki does translation using [Vue i18n](https://kazupon.github.io/vue-i18n).
rotki does translation using [Vue i18n](https://kazupon.github.io/vue-i18n).

Rotki's main language is `English`. The language file for it is [here](https://github.com/rotki/rotki/blob/develop/frontend/app/src/locales/en.json).
rotki's main language is `English`. The language file for it is [here](https://github.com/rotki/rotki/blob/develop/frontend/app/src/locales/en.json).
To fill in the translation for another language, you should pay attention to the following things:

1. The `JSON` structure from the `English` language file is absolute, meaning you can't change the JSON structure (the keys), because this is how rotki reads which value to use. So for translations of other languages, please follow the same structure as the `English` language JSON file. For example:
Expand Down
2 changes: 1 addition & 1 deletion contribution-guides/manual-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ If time allows, test the following on the binaries for all OSes. If not, test on

## Updating the Documentation

Rotki is continuously changing, and sometimes documentation becomes outdated. One way to contribute to rotki is by helping to keep the documentation up to date. To do so, you have to edit the corresponding section in the `.rst` files inside the `docs` folder of the git repo.
rotki is continuously changing, and sometimes documentation becomes outdated. One way to contribute to rotki is by helping to keep the documentation up to date. To do so, you have to edit the corresponding section in the `.rst` files inside the `docs` folder of the git repo.

To review your changes, you can compile the documentation using the command:

Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
layout: home

hero:
name: "Rotki"
name: "rotki"
text: The portfolio manager that protects your privacy
tagline: All you need to start using rotki, or contributing to it.
image:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "1.0.0",
"private": true,
"packageManager": "[email protected]",
"description": "Rotki's user guide and facing documentation",
"description": "rotki's user guide and facing documentation",
"keywords": [
"static",
"documentation",
Expand Down
4 changes: 2 additions & 2 deletions requirement-and-installation/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ If you modified the `@rotki/common` package, you might need to rebuild it:
pnpm run --filter @rotki/common build
```

### Running Rotki
### Running rotki

Start the application from the `frontend` directory:

Expand Down Expand Up @@ -228,7 +228,7 @@ You can use the [Nix](https://nixos.org/download) package manager to start rotki

```nix
{
description = "Rotki project with virtualenv";
description = "rotki project with virtualenv";
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.11";
Expand Down
2 changes: 1 addition & 1 deletion requirement-and-installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The easiest way to start rotki is to download the packaged binary for your operating system. Linux, macOS, and Windows are supported. To see how to do this, go to the [next section](/requirement-and-installation/packaged-binaries).

If you have Rotki installed and running well, you can go to the [usage guide](/usage-guides/)
If you have rotki installed and running well, you can go to the [usage guide](/usage-guides/)
8 changes: 4 additions & 4 deletions usage-guides/accessing-db-manually.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ To detect potential problems with data or modify the state of the database, you

1. **Download and Install**: Get [DB Browser for SQLite](https://sqlitebrowser.org/dl/). It's available for Windows, macOS, and Linux.
2. **Starting the Program**: Launch the program with the SQLCipher functionality.
3. **Opening the Rotki Database**:
- Navigate to the Rotki database in the [rotki data directory](/usage-guides/data-directory.html#rotki-data-directory).
- Enter the password you use to unlock your Rotki account to decrypt the database.
3. **Opening the rotki Database**:
- Navigate to the rotki database in the [rotki data directory](/usage-guides/data-directory.html#rotki-data-directory).
- Enter the password you use to unlock your rotki account to decrypt the database.
4. **Browsing and Modifying Data**:
- Use the `Browse Data` tab to view the information.
- Execute custom SQL commands if needed. However, be cautious and ensure you have double-checked commands with our team or are confident in what you are doing.
Expand All @@ -25,4 +25,4 @@ To detect potential problems with data or modify the state of the database, you
PRAGMA key='your-secret-key';
```

By following these steps, you can access and modify the Rotki database securely. Always ensure to backup your database before making any changes.
By following these steps, you can access and modify the rotki database securely. Always ensure to backup your database before making any changes.
10 changes: 5 additions & 5 deletions usage-guides/accounts-and-balances.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ To manage Accounts & Balances (Blockchain Balances, Exchange Balances, and Manua

## Adding and Removing Blockchain Accounts

Rotki allows to track balances of blockchain accounts.
rotki allows to track balances of blockchain accounts.

For now, the following chains are supported in Rotki (and the list will be growing as we add more chains in the future):
For now, the following chains are supported in rotki (and the list will be growing as we add more chains in the future):

- **EVM Chains**:

Expand Down Expand Up @@ -77,7 +77,7 @@ An xpub does not allow spending your coins but provides information about your w

## ENS names resolution

Rotki automatically resolves ens name and ens avatar for every evm address that has ens name set in ethereum mainnet. If there is a primary ens name specified for an address, this name will be shown instead of a raw blockchain address across the app. You can find the blockchain address by hovering the mouse over the ens name. If an ens avatar is set, it will be shown instead of the address blockie.
rotki automatically resolves ens name and ens avatar for every evm address that has ens name set in ethereum mainnet. If there is a primary ens name specified for an address, this name will be shown instead of a raw blockchain address across the app. You can find the blockchain address by hovering the mouse over the ens name. If an ens avatar is set, it will be shown instead of the address blockie.

## Token detection

Expand Down Expand Up @@ -134,7 +134,7 @@ From the balances section you can quickly get an overview of the accounts having

## NFTs

Rotki provides an NFT gallery where you can view the NFTs owned by your accounts.
rotki provides an NFT gallery where you can view the NFTs owned by your accounts.

![NFT Gallery](/images/sc_nfts.png)

Expand Down Expand Up @@ -232,7 +232,7 @@ If you stake on Kraken you can see your gains, and events in the various staked

## Airdrops

Rotki can detect some airdrops for you
rotki can detect some airdrops for you

![rotki airdrops detection](/images/rotki_airdrops.png)

Expand Down
2 changes: 1 addition & 1 deletion usage-guides/address-book.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Address Book

Rotki provides an address book for blockchains. This replaces addresses with names provided by the user across the application. You can click on `Save this name for all chains` to use the name for the provided address on all chains where that address appears. The address book is split into two different kinds:
rotki provides an address book for blockchains. This replaces addresses with names provided by the user across the application. You can click on `Save this name for all chains` to use the name for the provided address on all chains where that address appears. The address book is split into two different kinds:

1. **Global Addressbook**: It replaces addresses with the names provided across the entire application irrespective of the user logged in.
2. **Private Addressbook**: It replaces addresses with the names provided for the user currently logged in. It takes precedence over names found in the global address book.
Expand Down
2 changes: 1 addition & 1 deletion usage-guides/assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ on the frontend.

## Special assets

Rotki allows you to track special assets like:
rotki allows you to track special assets like:

1. _Uniswap/Sushiswap LP tokens_: You can track LP tokens by adding them and using `UNI-V2` as protocol. This will make the app query balances and prices. As for now historical prices are not queried so you will need to add missing prices manually.
2. _Yearn vaults_: To add a yearn vault you need to add a new ethereum token and use `yearn_vaults_v2` as protocol. In addition you need to specify the underlying token that the vault uses with a 100% weight.
Expand Down
2 changes: 1 addition & 1 deletion usage-guides/backend-arguments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Set the backend's arguments

Rotki runs a Python daemon on the backend. Most times you won't need to customize its arguments, but if you need to do so, especially for debugging purposes, this is how you can.
rotki runs a Python daemon on the backend. Most times you won't need to customize its arguments, but if you need to do so, especially for debugging purposes, this is how you can.

Create or edit (if it exists) a file with the name `rotki_config.json` in the same directory as the rotki executable. Add to the JSON object any arguments that are also arguments of rotki. Then when rotki starts, these will be passed as arguments to the backend. An example `rotki_config.json` follows:

Expand Down
8 changes: 4 additions & 4 deletions usage-guides/calendar.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Calendar

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.
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.

![Calendar view](/images/rotki_calendar.png)

![Add calendar event](/images/rotki_add_calendar_event.png)

Here the non-obvious fields are:

- **Notify me at event time**: Whether to also notify the user at the event time. If this setting is turned off, Rotki will not notify you at the event time, other than the reminder you set beforehand.
- **Notify me at event time**: Whether to also notify the user at the event time. If this setting is turned off, rotki will not notify you at the event time, other than the reminder you set beforehand.
- **Delete event once it has passed**: Whether to remove events after the time has passed. We recommend turning this feature on to save space, unless you want to keep the event.

## Automatic events

Rotki can also create automatic events based on your on-chain activity. The events that Rotki currently can check include:
rotki can also create automatic events based on your on-chain activity. The events that rotki currently can check include:

- ENS Expiration & Renewal

You can customize how Rotki handles automatic events by clicking the `setting` icon at the top.
You can customize how rotki handles automatic events by clicking the `setting` icon at the top.

![Automatic events setting](/images/rotki_calendar_automatic_events_setting.png)

Expand Down
12 changes: 6 additions & 6 deletions usage-guides/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This section provides information on how to customize the application through th

## Profit Currency

Rotki calculates everything, including your total profit/loss during the PnL report, in a given fiat currency, called the `profit_currency`. By default, this is USD. You can change this by clicking on the currency icon in the top right menu and selecting your preferred currency.
rotki calculates everything, including your total profit/loss during the PnL report, in a given fiat currency, called the `profit_currency`. By default, this is USD. You can change this by clicking on the currency icon in the top right menu and selecting your preferred currency.

![Changing the profit currency](/images/sc_profit_currency.png)

Expand Down Expand Up @@ -98,7 +98,7 @@ In this menu you can also edit, delete or add more nodes.

#### Connecting to a Kusama Client

> Rotki attempts to connect to a local Kusama node running on the default port `9933`. If no client is running, blockchain queries will use an external service.
> rotki attempts to connect to a local Kusama node running on the default port `9933`. If no client is running, blockchain queries will use an external service.
#### Connecting to a Polkadot Client

Expand Down Expand Up @@ -283,7 +283,7 @@ The above does not happen.
#### Have Summary

> Specify whether the all_events CSV export should include a summary of all events and the total profit/loss at the end. This summary would also include the Rotki version and the settings used during the PnL report, making it easier to reproduce a report run.
> Specify whether the all_events CSV export should include a summary of all events and the total profit/loss at the end. This summary would also include the rotki version and the settings used during the PnL report, making it easier to reproduce a report run.
## Data & Security Settings

Expand Down Expand Up @@ -320,13 +320,13 @@ There are two options to reset the assets database:

### Purging Data

Rotki keeps a lot of data cached locally. Clean this data periodically from the "Manage Data" section in the settings. Remove specific exchanges by first removing any active API keys.
rotki keeps a lot of data cached locally. Clean this data periodically from the "Manage Data" section in the settings. Remove specific exchanges by first removing any active API keys.

![Purging user data](/images/sc_purge_data.png)

### Manage Historical Price Oracle Cache

Querying historical prices from oracles such as CryptoCompare and CoinGecko is slow and can be slower due to rate limiting. Rotki creates historical price caches during idle times.
Querying historical prices from oracles such as CryptoCompare and CoinGecko is slow and can be slower due to rate limiting. rotki creates historical price caches during idle times.

Request the creation of such a cache by going to the Oracle cache section, selecting the oracle, the from asset of the pair, the to asset of the pair, and then pressing "Cache pair prices".

Expand All @@ -350,7 +350,7 @@ View all modules in the table. Some are activated by default. Enable/disable a m

![Select address for modules](/images/module_settings_select_address.png)

To limit querying to selected addresses, click the "edit/pencil" button on the module to select addresses. If no addresses are selected, Rotki checks all eligible addresses, increasing query duration.
To limit querying to selected addresses, click the "edit/pencil" button on the module to select addresses. If no addresses are selected, rotki checks all eligible addresses, increasing query duration.

## Backend Settings

Expand Down
4 changes: 2 additions & 2 deletions usage-guides/data-directory.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rotki data directory
# rotki data directory

Rotki saves user data by default in a different directory per OS. For each OS, data is stored in the respective standards-compliant equivalent directory.
rotki saves user data by default in a different directory per OS. For each OS, data is stored in the respective standards-compliant equivalent directory.

- **Linux**: `~/.local/share/rotki/data/`
- **OSX**: `~/Library/Application Support/rotki/data` - please note this folder is hidden by default
Expand Down
4 changes: 2 additions & 2 deletions usage-guides/decentralized-finance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To track and analyze your DeFi actions use the Decentralized Finance tab from th

## Overview

Rotki provides an overview of your assets in the different Defi protocols.
rotki provides an overview of your assets in the different Defi protocols.

![Defi Overview](/images/defi_overview.png)

Expand Down Expand Up @@ -43,7 +43,7 @@ Finally you need to have a premium subscription in order for the total amount of

![Defi LP positions in the dashboard](/images/lps_in_dashboard.png)

Rotki allows its users to keep track of their Liquidity Pools. An overview is available in the dashboard and it is also possible to get a per protocol view in the deposits section.
rotki allows its users to keep track of their Liquidity Pools. An overview is available in the dashboard and it is also possible to get a per protocol view in the deposits section.

![Defi Liquidity Pools](/images/sc_decentralized_lp.png)

Expand Down
Loading

0 comments on commit 88597b1

Please sign in to comment.