A local-first personal finance app
[Docs] Tour: Update reports, payees, schedules and rules pages. (#7405)
Juulz64b2d9b31a2b
diff --git a/.github/actions/docs-spelling/expect.txt b/.github/actions/docs-spelling/expect.txtindex bc2704b13f..abcbf699ba 100644--- a/.github/actions/docs-spelling/expect.txt+++ b/.github/actions/docs-spelling/expect.txt@@ -133,6 +133,7 @@ overbudgetingoxcParibaspasswordless+PAYPALpicomatchpluggyaiPostediff --git a/packages/docs/docs/tour/payees.md b/packages/docs/docs/tour/payees.mdindex 676ff6bc8d..e2e31e09c0 100644--- a/packages/docs/docs/tour/payees.md+++ b/packages/docs/docs/tour/payees.md@@ -1,17 +1,17 @@# Payees Management-This view lets you manage your Payees. In the overview, you see which Payees you have in your system and if they have any associated [rules](./rules).+This view lets you manage your Payees. See [Payees](/docs/transactions/payees) for more details.-From this view, you can delete and merge payees as you see fit. See the [Payee section](/docs/transactions/payees) in the manual for more details.+In the overview, you can see which Payees you have used in your system and if they have any associated [rules](./rules).If you have any unused payees, they are readily available by clicking on the _Show n unused payee_.-+## Deleting or merging payees-Select the payees you want to merge or delete and choose the corresponding function in the dropdown seen inside the red box.+Select the payees you want to merge or delete and choose the corresponding function in the dropdown box.If you need to undo a merge or a delete operation, you can press <Key mod="ctrl" fixed k="Z" /> on a Windows machine, or <Key mod="cmd" fixed k="Z" /> on a Mac.-+diff --git a/packages/docs/docs/tour/reports.md b/packages/docs/docs/tour/reports.mdindex 7478c1eb87..9834cd6dd1 100644--- a/packages/docs/docs/tour/reports.md+++ b/packages/docs/docs/tour/reports.md@@ -1,33 +1,24 @@# Reports-This view gives you access to both the two built in reports, _Net Worth_ and _Cash Flow_, but also your own custom reports.+This view gives you access both to the built-in reports and also to your own custom reports.-All reports in this view are shown in their small, tiled, version. Clicking on a tile will take you to that very report.+All reports in this view are shown in their tiled version. Clicking on a tile will take you to a full-screen version of that report.-## The built in reports+**Net worth** represents the overall balance of all your accounts over time. It is calculated by subtracting your debts from the total value of your cash and assets. This includes all investments. Essentially, your net worth is the amount you would have if you sold all of your assets and paid off all of your debts.-**Net worth** represents the overall balance of all your accounts over time. It is calculated by subtracting your debts-from the total value of your cash and assets. This includes all investments. Essentially, your net worth is the amount-you would have if you sold all your assets and paid off all your debts.+**Cash flow** tracks your spending over time by focusing solely on budget accounts and displaying their balances. It includes separate visualizations for income and expenses, providing a quick overview of how these factors affect your available money over time. By considering your budgeted accounts as "cash on hand," cash flow clearly shows how your available funds fluctuate.-**Cash flow** tracks your spending over time by focusing solely on budget accounts and displaying their balances.-It includes separate visualizations for income and expenses, providing a quick overview of how these factors affect-your available money over time. By considering your budgeted accounts as "cash on hand," cash flow clearly shows how your available funds fluctuate.--These reports are detailed in the [reports section](/docs/reports/) in the manual.+See the [Reports Dashboard](/docs/reports/) for more detail on these and the other built-in reports.## Custom reports-Actual custom reports should give you all the reports you need on your spending habits and your income and are-thoroughly covered in the [Custom Reports topic](/docs/reports/custom-reports) in the manual.+Actual's custom reports will allow you to create reports giving in-depth analyses on your spending habits and your income. You can find them thoroughly covered in [Custom Reports](/docs/reports/custom-reports).-Below are examples of reports covering our *Daily Expenses* over the last six months. One report shows this as a graph,-the other as a table. Note that the table version also shows the sum and average (over six months)-for the various categories.+Below are examples of reports covering *Daily Expenses* over the last six months. One report shows this as a graph, the other as a table. Note that the table version also shows the sum and average (over six months) for the various categories.diff --git a/packages/docs/docs/tour/rules.md b/packages/docs/docs/tour/rules.mdindex b587f2b778..486dfb8ff2 100644--- a/packages/docs/docs/tour/rules.md+++ b/packages/docs/docs/tour/rules.md@@ -2,11 +2,8 @@Actual's robust rules system will help you automate many transaction management tasks.-Rules dictate how transactions are handled. When transactions are imported or synced, they follow-rules that apply specific actions. For instance, a rule might process a transaction with the payee-"AMAZON.COM\*5C7QC7MH0 AM 10/26 PURCHASE AMZN.COM/BILL," recognize the keyword "amazon," and automatically-set the payee to "Amazon" and the category to "Books". Rules enable you to automate any workflow you choose.+Rules dictate how transactions are handled. When transactions are imported or synced, they follow rules that apply specific actions. For instance, a rule might process a transaction with the payee "PAYPAL \*LOWES.COM 8448964938 NC", recognize the keyword "lowes," and automatically set the payee to "Lowe's" and the category to "Home Improvement". Rules enable you to automate any workflow you choose.-For detailed information, please consult the manual section on [rules](/docs/budgeting/rules/).+For detailed information, please see [Rules](/docs/budgeting/rules/).-+diff --git a/packages/docs/docs/tour/schedules.md b/packages/docs/docs/tour/schedules.mdindex 76208cc0cb..f6676d936b 100644--- a/packages/docs/docs/tour/schedules.md+++ b/packages/docs/docs/tour/schedules.md@@ -2,14 +2,13 @@If you already have data in your accounts, you can have Actual propose schedules based on the available data.-The system is very flexible, and you can schedule based on various factors:+The system is very flexible:-1. Set to be recurring or only entered once-2. Set to be automatically entered into the account register or choose to manually approve entries-3. Options for recurring entries for multiple specific days of the month.- 1. A single schedule can be created for a Cell phone plan with multiple users and different payment cycles for each phone. For example, if you have three cell phones that all get paid on different days of the month, each day can be defined in a single schedule for each phone.-4. Options to determine the frequency of payments, such as every month, every 2 months, every 2 years, etc.+- Schedules can recur indefinitely, have an end date or only occur once.+- The schedule can enter the transaction automatically into the account register or notify you to manually approve entry.+- Recurring transactions can be set to one or multiple specific days of the month. For example, a single schedule can be created for a cell phone plan with multiple users and different payment cycles for each phone. If you have three cell phones that all get paid on different days of the month, each day can be defined in a single schedule.+- Schedules have various options for the frequency of transactions, such as every month, every month on the 2nd Wednesday, every 2 months, every 2 years, etc.-The manual's [Schedules](/docs/schedules) section contains all the details surrounding scheduling in Actual Budget.+For more details, see [Schedules](/docs/schedules).-+