Skip to content

A local-first personal finance app

Update Settings doc - fixes issue #6183 (#6197)

Juulz7a4ec20bac8f
diff --git a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-loads-cash-flow-graph-and-checks-visuals-1-chromium-linux.png b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-loads-cash-flow-graph-and-checks-visuals-1-chromium-linux.png
index ef38d7f1e2..7fd766a761 100644
Binary files a/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-loads-cash-flow-graph-and-checks-visuals-1-chromium-linux.png and b/packages/desktop-client/e2e/reports.test.ts-snapshots/Reports-loads-cash-flow-graph-and-checks-visuals-1-chromium-linux.png differ
diff --git a/packages/docs/docs/settings/index.md b/packages/docs/docs/settings/index.md
index c39550a4b7..0ef18cf01f 100644
--- a/packages/docs/docs/settings/index.md
+++ b/packages/docs/docs/settings/index.md
@@ -1,10 +1,16 @@
# Settings
-The Settings screen in Actual provides you with a number of options for managing the look and feel of your budget along with some more system specific settings.
+The Settings screen in Actual provides you with a number of options for managing the look and feel of your budget along with some more system specific settings. Most settings are self-explanatory.
You can access the Settings screen by clicking the down arrow by your budget name or going to the sidebar and clicking More > Settings.
-![](/img/using-actual/settings-1.png)
+There is an option to "Display a notification when updates are available" here.
+
+![Image of Settings top pf page](/img/using-actual/actual-settings.png)
+
+### Themes
+
+Themes change the user interface colors
### Formatting
@@ -15,43 +21,78 @@ The formatting options allow you to select the following:
- Your preferred first day of the week
- The option to "Hide decimal places"
-![](/img/using-actual/settings-formatting.png)
+![Image of Formatting setting](/img/using-actual/settings-formatting.png)
+
+### Language
+
+The language choice alters the display language of all text. If you encounter a translation error, feel free to make a suggestion on [Weblate](https://hosted.weblate.org/projects/actualbudget/actual/).
+
+![Image of language setting](/img/using-actual/actual-languages.png)
+
+
+### Authentication Method
+
+OpenID can be enabled here. [Learn more](/docs/config/oauth-auth)
+
+![Image of OpenID setting](/img/using-actual/actual-openid.png)
### Encryption
-End-to-end encryption allows you to encrypt the data on your remote server with a password. If you don't trust the server's owners, enable this setting to fully encrypt the data. Read more about this feature on the [Syncing Across Devices page.](/docs/getting-started/sync/#end-to-end-encryption)
+End-to-end encryption allows you to encrypt the data on your remote server with a password. If you don't trust the server's owners, enable this setting to fully encrypt the data. [Learn more](/docs/getting-started/sync/#end-to-end-encryption)
-![](/img/using-actual/settings-encryption.png)
+![Image of Encryption setting](/img/using-actual/settings-encryption.png)
+
+### Budgeting Method
+
+Either Envelope or Tracking Budgeting methods are available in Actual. Envelope Budgeting is recommended and most of the documentation refers to this method.
+
+[Learn more about Envelope Budgeting](/docs/getting-started/envelope-budgeting)
+<br />
+[Learn more about Tracking Budgeting](/docs/getting-started/tracking-budget)
+<br />
+<br />
+![Image of budgeting methods setting](/img/using-actual/actual-budget-method.png)
### Export
-This section allows you to download a `.zip` archive of all of your server data for easy backup or migration.
+This section allows you to download a `.zip` archive of all of your server data for easy backup or migration. [Learn more](/docs/backup-restore/backup)
-![](/img/using-actual/settings-export.png)
+![Image of Export setting](/img/using-actual/settings-export.png)
## Advanced Settings
-Click on the `Show advanced settings` button to open the advanced section of the Settings page.
-
-![](/img/using-actual/settings-advanced.png)
+Click on the `Show advanced settings` link to open the advanced section of the Settings page.
### Budget ID
-Your Budget ID is a unique identifier that identifies the specific budget file that you have open. You can have many budgets per install of Actual and this allows you to identify which budget the data relates to.
+You can have many budgets per install of Actual, each has it's own IDs.
+IDs are the names Actual uses to identify your budget internally. The Budget ID is used to identify your budget file. If you are using a server, the Sync ID is used to access the budget on the server.
+
+![Image of BudgetID setting](/img/using-actual/actual-budgetid.png)
### Reset Budget Cache
-Resetting the Budget Cache clears all cached values and will completely re-calculate your entire budget. Many of these values are cached on your browser to improve performance.
+**Reset budget cache** will clear all cached values for the budget and recalculate the entire budget. All values in the budget are cached for performance reasons, and if there is a bug in the cache you won’t see correct values. There is no danger in resetting the cache.
+
+![Image of Reset Cache setting](/img/using-actual/actual-budget-cache.png)
### Reset Sync
-Actual's sync function is quite complicated and is covered in detail [here](../getting-started/sync.md#what-does-resetting-sync-mean). This is typically the last-resort to fix any potential issues with sending budget files between other devices.
+Actual's sync function is quite complicated and is covered in detail [here](../getting-started/sync.md#what-does-resetting-sync-mean). Use this if there is a problem with syncing and you want to start fresh.
+
+**Note:** Resetting sync will also significantly reduce your budget file size. This is because Actual stores all mutations in the budget file by default, causing it to grow over time. When you reset sync, all those historical changes are compressed into a single file.
+
+![Image of Reset Sync setting](/img/using-actual/actual-reset-sync.png)
### Repair Split Transactions
-If you are experiencing bugs relating to split transactions and the “Reset budget cache” button above does not help, this tool may fix them.
+If you are experiencing bugs relating to split transactions or transfers and the “Reset budget cache” button above does not help, this tool may fix them.
+
+![Image of Repair Splits setting](/img/using-actual/actual-repair.png)
### Experimental Features
This section is where you can enable features that are still in development and testing.
-See the [experimental feature documentation](../experimental) for more information.
+See [Experimental features](../experimental) for more information.
+
+![Image of Experimental setting](/img/using-actual/actual-experimental.png)
diff --git a/packages/docs/static/img/using-actual/actual-budget-cache.png b/packages/docs/static/img/using-actual/actual-budget-cache.png
new file mode 100644
index 0000000000..8b805eaa9f
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-budget-cache.png differ
diff --git a/packages/docs/static/img/using-actual/actual-budget-method.png b/packages/docs/static/img/using-actual/actual-budget-method.png
new file mode 100644
index 0000000000..c4871d5fbc
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-budget-method.png differ
diff --git a/packages/docs/static/img/using-actual/actual-budgetid.png b/packages/docs/static/img/using-actual/actual-budgetid.png
new file mode 100644
index 0000000000..a1918f3c3f
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-budgetid.png differ
diff --git a/packages/docs/static/img/using-actual/actual-experimental.png b/packages/docs/static/img/using-actual/actual-experimental.png
new file mode 100644
index 0000000000..24c9caacdf
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-experimental.png differ
diff --git a/packages/docs/static/img/using-actual/actual-languages.png b/packages/docs/static/img/using-actual/actual-languages.png
new file mode 100644
index 0000000000..8f70ec67ac
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-languages.png differ
diff --git a/packages/docs/static/img/using-actual/actual-openid.png b/packages/docs/static/img/using-actual/actual-openid.png
new file mode 100644
index 0000000000..819993130e
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-openid.png differ
diff --git a/packages/docs/static/img/using-actual/actual-repair.png b/packages/docs/static/img/using-actual/actual-repair.png
new file mode 100644
index 0000000000..25d3b49ec5
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-repair.png differ
diff --git a/packages/docs/static/img/using-actual/actual-reset-sync.png b/packages/docs/static/img/using-actual/actual-reset-sync.png
new file mode 100644
index 0000000000..98e4854bfb
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-reset-sync.png differ
diff --git a/packages/docs/static/img/using-actual/actual-settings.png b/packages/docs/static/img/using-actual/actual-settings.png
new file mode 100644
index 0000000000..82ac410102
Binary files /dev/null and b/packages/docs/static/img/using-actual/actual-settings.png differ