Skip to content

A local-first personal finance app

Update report budget docs (#425)

Robert Dyerbaba070bafe7
diff --git a/docs-sidebar.js b/docs-sidebar.js
index 14dda59c76..cf91dbfe57 100644
--- a/docs-sidebar.js
+++ b/docs-sidebar.js
@@ -241,7 +241,7 @@ const sidebars = {
items: [
'experimental/goal-templates',
'experimental/monthly-cleanup',
- 'experimental/report-budget',
+ 'experimental/tracking-budget',
'experimental/simplefin-sync',
],
},
diff --git a/docs/experimental/report-budget.md b/docs/experimental/tracking-budget.md
similarity index 72%
rename from docs/experimental/report-budget.md
rename to docs/experimental/tracking-budget.md
index 6fa3ed4aa6..55ed2a2367 100644
--- a/docs/experimental/report-budget.md
+++ b/docs/experimental/tracking-budget.md
@@ -1,24 +1,25 @@
-# Report Budget
+# Tracking Budget
:::warning
This is an **experimental feature**. That means we’re still working on finishing it. There may be bugs, missing functionality or incomplete documentation, and we may decide to remove the feature in a future release. If you have any feedback, please [open an issue](https://github.com/actualbudget/actual/issues) or post a message in the Discord.
:::
-## Enabling the Report Budget
+## Enabling the Tracking Budget
-The **Report Budget** feature can be switched on from the Experimental features section within the Settings page. Navigate back to the **Budget** screen and a new button labeled **Rollover Budget** will be visible at the top of the screen. Select the button and use the option to **Switch to a Report Budget**.
+The **Tracking Budget** feature can be switched on from the Experimental features section within the Settings page by enabling "Budget mode toggle".
+Then scroll up in the settings menu and click "Switch to tracking budgeting".
-![](/img/report-budget-7.png)
+![](/img/tracking-budget-7.png)
## Creating a budget
-There are several important differences between the **Report Budget** and the default **Rollover Budget** type.
+There are several important differences between the **Tracking Budget** and the default **Envelope Budget** type.
- Category balances do not rollover from month to month
- "To Be Budgeted" has been replaced with a "Saved" metric
- Income is forecasted rather than using what is available
-![](/img/report-budget-1.png)
+![](/img/tracking-budget-1.png)
If you are creating a budget for the first time, here's how it works:
@@ -31,29 +32,29 @@ Once completing these two tasks for the month, you will see the budgeted totals
As you can see in the following example, your total budgeted items show in the right hand side of the summary for both your **Income** and **Expenses** and your actual expenses and income are totaled in the left hand side of the summary. The **Projected Savings** field is calculated from your budgeted income minus budgeted expenses, so expect the **Projected Savings** to decrease when covering overspending.
-![](/img/report-budget-2.png)
+![](/img/tracking-budget-2.png)
There are useful pie charts next to **Income** and **Expenses** to track your progress visually.
-![](/img/report-budget-5.png)
+![](/img/tracking-budget-5.png)
- An incomplete green pie means your total expenses or income are less than your total amount budgeted for expenses or income, respectively.
-![](/img/report-budget-4.png)
+![](/img/tracking-budget-4.png)
- A complete green pie chart means your spending and budget are exactly the same.
-![](/img/report-budget-6.png)
+![](/img/tracking-budget-6.png)
- A pie chart that has turned red means you have overspent your total budget.
When a new month begins, your **Projected Savings** changes to **Saved** or **Overspent**, depending on your final transactions. The final savings amount calculated for this field is your actual income minus your actual expenses. If you hover your mouse over the **Saved** or **Overspent** text, you can view the breakdown of projected and actual savings for the month.
-![](/img/report-budget-3.png)
+![](/img/tracking-budget-3.png)
## How money rolls over
-Money does not automatically carry over from month to month in the **Report Budget**. If you have overspending in any category, you may wish to carry this balance forward into the next month. This can be done by clicking on the **Balance** of the category and select **Rollover Overspending**.
+Money does not automatically carry over from month to month in the **Tracking Budget**. If you have overspending in any category, you may wish to carry this balance forward into the next month. This can be done by clicking on the **Balance** of the category and select **Rollover Overspending**.
:::note
If you utilize the **Rollover Overspending** feature on a category that is not over spent, the entire spent amount will be forwarded to the next month and the **Saved** amount will increase for the current month.
@@ -61,9 +62,9 @@ If you utilize the **Rollover Overspending** feature on a category that is not o
## Working with the Budget
-Some of the features of the **Rollover Budget** are available in the **Report Budget**.
+Some of the features of the **Envelope Budget** are available in the **Tracking Budget**.
:::note
-Not all features of the **Rollover Budget** have been implemented in the **Report Budget**. If you find critical functionality missing that you need, please submit a request on [GitHub](/contact).
+Not all features of the **Envelope Budget** have been implemented in the **Tracking Budget**. If you find critical functionality missing that you need, please submit a request on [GitHub](/contact).
:::
- [Create new budgets for the next month](../budgeting/index.md#creating-a-budget)
diff --git a/static/img/report-budget-7.png b/static/img/report-budget-7.png
deleted file mode 100644
index a0030466ae..0000000000
Binary files a/static/img/report-budget-7.png and /dev/null differ
diff --git a/static/img/report-budget-1.png b/static/img/tracking-budget-1.png
similarity index 100%
rename from static/img/report-budget-1.png
rename to static/img/tracking-budget-1.png
diff --git a/static/img/report-budget-2.png b/static/img/tracking-budget-2.png
similarity index 100%
rename from static/img/report-budget-2.png
rename to static/img/tracking-budget-2.png
diff --git a/static/img/report-budget-3.png b/static/img/tracking-budget-3.png
similarity index 100%
rename from static/img/report-budget-3.png
rename to static/img/tracking-budget-3.png
diff --git a/static/img/report-budget-4.png b/static/img/tracking-budget-4.png
similarity index 100%
rename from static/img/report-budget-4.png
rename to static/img/tracking-budget-4.png
diff --git a/static/img/report-budget-5.png b/static/img/tracking-budget-5.png
similarity index 100%
rename from static/img/report-budget-5.png
rename to static/img/tracking-budget-5.png
diff --git a/static/img/report-budget-6.png b/static/img/tracking-budget-6.png
similarity index 100%
rename from static/img/report-budget-6.png
rename to static/img/tracking-budget-6.png
diff --git a/static/img/tracking-budget-7.png b/static/img/tracking-budget-7.png
new file mode 100644
index 0000000000..d9d202b309
Binary files /dev/null and b/static/img/tracking-budget-7.png differ