Reorganising the menu items (#429)

1. Moved _Filtering_ from _Reports & Filters_ to _Accounts & Transactions_ as it's are more natural place to have the filter documentation. 2. Renamed _Reports & Filters_ to just _Reports_ 3. Moved _Schedules_ out of _Budgeting_ to better reflect the sidebar items in the program. 4. Based on feedback from Michael Burnside on Discord, moved the envelope budgeting docs higher up in the menu. What he wrote on Discord: _I think the Envelope Budgeting doc should be moved up in the list. It's important to understand the method and the "Why" first, so that users can make sense of the tool and the "how". I know there's a link at the top of the Starting Fresh article, but people tend to go top to bottom in the contents (if they're reading at all)._ 5. Moved _A Tour of Actual_ out of _Getting started_ as it's marketing and not getting started with the program. 6. Moved _Starting Fresh_ higher up to differentiate between the tech stuff and the why stuff. **There is no change in content - just trying to make the menu a better place to navigate** --------- Co-authored-by: Ruben Olsen Lærk <[email protected]>
actualbudget · Sep 15, 2024 · 0b8f267 · 0b8f267
1 parent 1c1531e
commit 0b8f267
Show file tree

Hide file tree

Showing 11 changed files with 143 additions and 151 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,12 +7,10 @@
 .idea
 *.iml
 
+# Yarn
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
-
-# Yarn
 .pnp.*
 .yarn/*
 !.yarn/patches

diff --git a/docs-sidebar.js b/docs-sidebar.js
@@ -28,15 +28,33 @@ const sidebars = {
     'index',
     'vision',
     'releases',
+    {
+      type: 'category',
+      label: 'A Tour of Actual',
+      link: {
+        type: 'doc',
+        id: 'tour/index',
+            },
+            items: [
+        'tour/user-interface',
+        'tour/budget',
+        'tour/accounts',
+        'tour/reports',
+        'tour/schedules',
+        'tour/payees',
+        'tour/rules',
+            ],
+    },
     {
       type: 'category',
       label: 'Getting Started',
       collapsible: false,
       items: [
-        'getting-started/roadmap-for-new-users',
+      'getting-started/roadmap-for-new-users',
+      'getting-started/envelope-budgeting',
         {
           type: 'category',
-          label: 'Installing Actual',
+          label: 'Installation and Configuration',
           link: {
             type: 'doc',
             id: 'install/index',
@@ -48,45 +66,25 @@ const sidebars = {
               collapsible: false,
               items: ['install/local', 'install/docker'],
             },
+
             {
               type: 'category',
               label: 'In the Cloud',
               collapsible: false,
               items: ['install/pikapods', 'install/fly'],
             },
+
+            {
+              type: 'category',
+              label: 'Configuration',
+              collapsible: false,
+               items: [ 'config/index', 'config/https', 'advanced/http-header-auth', 'config/reverse-proxies' ],
+            },
+
           ],
         },
-        {
-          type: 'category',
-          label: 'Configuring the Server',
-          link: {
-            type: 'doc',
-            id: 'config/index',
-          },
-          items: ['config/https', 'config/reverse-proxies'],
-        },
-        {
-          type: 'category',
-          label: 'A Tour of Actual',
-          link: {
-            type: 'doc',
-            id: 'tour/index',
-          },
-          items: [
-            'tour/user-interface',
-            'tour/budget',
-            'tour/accounts',
-            'tour/reports',
-            'tour/schedules',
-            'tour/payees',
-            'tour/rules',
-          ],
-        },
-        'getting-started/starting-fresh',
-        'getting-started/tips-tricks',
-        'getting-started/sync',
-        'getting-started/manage-files',
-        'getting-started/envelope-budgeting',
+
+
         {
           type: 'category',
           label: 'Migration',
@@ -95,25 +93,25 @@ const sidebars = {
             id: 'migration/index',
           },
           items: [
-            {
-              type: 'category',
-              label: 'Migrating From Other Apps',
-              collapsible: false,
-              items: [
                 'migration/actual-import',
                 'migration/ynab4',
                 'migration/nynab',
-              ],
-            },
           ],
         },
+
+
       ],
     },
+
+
+
+
     {
       type: 'category',
       label: 'Using Actual',
       collapsible: false,
       items: [
+        'getting-started/starting-fresh',
         {
           type: 'category',
           label: 'Budgeting',
@@ -126,30 +124,37 @@ const sidebars = {
             'budgeting/categories',
             {
               type: 'category',
-              label: 'Rules',
-              collapsed: true,
-              link: {
-                type: 'doc',
-                id: 'budgeting/rules/index',
-              },
-              items: ['budgeting/rules/custom'],
-            },
-            'budgeting/schedules',
-            'budgeting/returns-and-reimbursements',
-            {
-              type: 'category',
-              label: 'Managing Credit Cards',
-              collapsed: true,
+              label: 'How to articles about budgeting',
+              collapsible: false,
               link: {
                 type: 'doc',
-                id: 'budgeting/credit-cards/index',
+                id: 'budgeting/index',
               },
-              items: ['budgeting/credit-cards/carrying-debt'],
+              items: [
+                'budgeting/returns-and-reimbursements',
+                {
+                  type: 'category',
+                  label: 'Managing Credit Cards',
+                  collapsible: true,
+                  link: {
+                    type: 'doc',
+                    id: 'budgeting/credit-cards/index',
+                  },
+                  items: ['budgeting/credit-cards/carrying-debt'],
+                },
+                'budgeting/joint-accounts',
+                'advanced/restart',
+              ]
             },
-            'budgeting/joint-accounts',
-            //unavailable('Returns and Reimbursements'),
           ],
         },
+
+        // End of Budgeting
+
+        'schedules',
+
+
+
         {
           type: 'category',
           label: 'Accounts & Transactions',
@@ -159,25 +164,38 @@ const sidebars = {
             id: 'accounts/index',
           },
           items: [
-            'accounts/reconciliation',
+            'transactions/filters',
+            'transactions/transfers',
+            {
+              type: 'category',
+              label: 'Rules',
+              collapsed: true,
+              link: {
+                type: 'doc',
+                id: 'budgeting/rules/index',
+              },
+              items: ['budgeting/rules/custom'],
+            },
             'transactions/importing',
-            'transactions/bulk-editing',
+            'accounts/reconciliation',
             'transactions/payees',
-            'transactions/transfers',
+            'transactions/bulk-editing',
+            'advanced/bank-sync',
+            'advanced/scripts/modify-transfers',
           ],
         },
+
+
         {
           type: 'category',
-          label: 'Reports & Filters',
+          label: 'Reports',
           collapsed: true,
           link: {
             type: 'doc',
-            id: 'reports-filters/index',
+            id: 'reports/index',
           },
           items: [
-            'reports-filters/filters',
-            'reports-filters/reports', 
-            'reports-filters/custom-reports'
+            'reports/custom-reports'
           ],
         },
         {
@@ -186,17 +204,24 @@ const sidebars = {
           collapsed: true,
           items: ['backup-restore/backup', 'backup-restore/restore'],
         },
+        'settings/index',
+        'getting-started/sync',
+        'getting-started/manage-files',
+
         {
           type: 'category',
-          label: 'Settings',
+          label: 'Experimental features',
           collapsed: true,
-          link: {
-            type: 'doc',
-            id: 'settings/index',
-          },
-           items: ['settings/index'],
+          items: [
+            'experimental/goal-templates',
+            'experimental/monthly-cleanup',
+            'experimental/tracking-budget',
+            'experimental/simplefin-sync',
+          ],
         },
-         {
+        'getting-started/tips-tricks',
+
+        {
           type: 'category',
           label: 'API',
           link: { type: 'doc', id: 'api/index' },
@@ -214,39 +239,21 @@ const sidebars = {
             },
           ],
         },
-        {
-          type: 'category',
-          label: 'Advanced',
-          collapsed: true,
-          link: {
-            type: 'doc',
-            id: 'advanced/index',
-          },
-          items: [
-            'advanced/bank-sync',
-            'advanced/http-header-auth',
-            'advanced/restart',
-            {
-              type: 'category',
-              label: 'Scripts',
-              collapsible: false,
-              items: ['advanced/scripts/modify-transfers'],
-            },
-          ],
-        },
-        {
-          type: 'category',
-          label: 'Experimental features',
-          collapsed: true,
-          items: [
-            'experimental/goal-templates',
-            'experimental/monthly-cleanup',
-            'experimental/tracking-budget',
-            'experimental/simplefin-sync',
-          ],
-        },
       ],
     },
+
+
+
+
+
+
+
+
+
+
+
+
+
     {
       type: 'category',
       label: 'Help & Support',

diff --git a/docs/getting-started/starting-fresh.md b/docs/getting-started/starting-fresh.md
@@ -3,7 +3,7 @@ title: 'Starting Fresh'
 ---
 For most users it's best to start fresh with a blank file.
 This guide will walk through setting up a budget file fresh without migrating from a previous budget software export.
-Before continuing, it might be a good idea to read about the [envelope method](envelope-budgeting), or zero-sum 
+Before continuing, it might be a good idea to read about the [envelope method](/docs/getting-started/envelope-budgeting), or zero-sum 
 budgeting as it's also called.
 
 ## 1. Setting up Accounts
@@ -101,7 +101,7 @@ You may also want a category for interest and dividends.
 Actual has a nifty and useful feature where you can group your expense categories into groups. 
 This not only provides more visibility and control over your spending but also empowers you 
 to make informed financial decisions.
-When using the [envelope method](./envelope-budgeting), one will move available funds between categories when 
+When using the [envelope method](/docs/getting-started/envelope-budgeting), one will move available funds between categories when 
 needed. However, there are some categories that you should be very wary about moving funds away 
 from. By grouping, you'll get an extra visual indication that moving funds from the Electricity 
 category, for instance, may not be the wisest choice. Another reason is to have a more convenient 
@@ -279,17 +279,17 @@ Shortly this method goes like this:
 
 :::info
 
-This topic is so important on how to actually use Actual, that we have devoted a separate page on **[envelope budgeting](envelope-budgeting)**.
+This topic is so important on how to actually use Actual, that we have devoted a separate page on **[envelope budgeting](/docs/getting-started/envelope-budgeting)**.
 
 :::
 
 
 ## The next step in your budgeting journey
 
 A good next step is to read through the "Using Actual" section of the documentation.  This section has detailed explainers on the 
-features of Actual and how to use them. Some of the most useful features are [Rules](../budgeting/rules/index.md), 
-[Schedules](../budgeting/schedules.md), [Reconciliation](../accounts/reconciliation.md), 
-and [Reports](../reports-filters/reports.md).
+features of Actual and how to use them. Some of the most useful features are [Rules](/docs/budgeting/rules/index.md), 
+[Schedules](/docs/schedules.md), [Reconciliation](/docs/accounts/reconciliation.md), 
+and [Reports](/docs/reports/index.md).
 
 
 If you feel a bit overwhelmed, don't worry.

diff --git a/docs/reports-filters/index.md b/docs/reports-filters/index.md