WIP

2026-03-05 18:57:12 +00:00
1 parent 38067df8c3
commit 492d86db9e
@@ -21,7 +21,10 @@
                        <strong>Create an account</strong> — Head to <a href="/accounts">Accounts</a> and add at least one financial account (e.g. "Current Account", "Savings"). Set the opening balance and choose a currency.
                    </li>
                    <li class="mb-2">
-                        <strong>Set up categories</strong> — Visit <a href="/categories">Categories</a> to organise your spending. Pick an emoji icon for each category to make them easy to spot.
+                        <strong>Set up categories</strong> — Visit <a href="/categories">Categories</a> to organise your spending. A set of default categories (including Salary) are provided automatically.
+                    </li>
+                    <li class="mb-2">
+                        <strong>Configure your salary</strong> — Visit <a href="/salary">Salary</a> to add your regular income sources. Each salary generates recurring Income transactions automatically and highlights paydays on the chart.
                    </li>
                    <li class="mb-2">
                        <strong>Record transactions</strong> — Go to <a href="/transactions">Transactions</a> or use the <strong>+ Add</strong> button on the <a href="/">Dashboard</a> to log income and expenses.
@@ -42,7 +45,7 @@
                <p>The <a href="/">Dashboard</a> is your home screen and gives you an at-a-glance view of your finances.</p>

                <h6>Balance Trend Chart</h6>
-                <p>The chart shows projected balances for each account over a time window starting from today. Use the preset buttons (<strong>7d</strong>, <strong>30d</strong>, <strong>90d</strong>, <strong>1y</strong>) to look ahead, or pick custom dates with the date pickers.</p>
+                <p>The chart shows projected balances for each account over a time window starting from today. Use the preset buttons (<strong>7d</strong>, <strong>30d</strong>, <strong>90d</strong>, <strong>1y</strong>) to look ahead, or pick custom dates with the date pickers. Payday dates from your <a href="/salary">Salary</a> sources are highlighted with a 💰 marker and a subtle green band.</p>

                <h6>Recent &amp; Upcoming Tabs</h6>
                <ul>
@@ -109,6 +112,36 @@
            </div>
        </div>

+        @* ── Salary ── *@
+        <div class="card mb-4" id="salary">
+            <div class="card-header">
+                <h5 class="mb-0">💰 Salary</h5>
+            </div>
+            <div class="card-body">
+                <p>The <a href="/salary">Salary</a> page lets you define regular income sources that generate recurring transactions automatically.</p>
+
+                <h6>Adding a Salary</h6>
+                <ul>
+                    <li><strong>Name</strong> — A label for this income source (e.g. "Main Job", "Freelance").</li>
+                    <li><strong>Amount</strong> — The net amount credited each payday.</li>
+                    <li><strong>Account</strong> — Which account receives the payment.</li>
+                    <li><strong>Recurrence</strong> — How often you are paid: <strong>Weekly</strong>, <strong>Monthly</strong> or <strong>Yearly</strong>.</li>
+                    <li><strong>First Payday</strong> — The date of the first payment. The day of month (or week) is derived from this and repeats indefinitely.</li>
+                </ul>
+
+                <h6>How Salary Transactions Work</h6>
+                <ul>
+                    <li>Salary transactions are generated automatically as Income entries up to the end of the current time window, and refreshed whenever you visit or change the date range on any page.</li>
+                    <li>They appear on the <a href="/transactions">Transactions</a> page with a 💰 badge and cannot be deleted from there — manage them on the Salary page instead.</li>
+                    <li>Payday dates are highlighted on the <a href="/">Dashboard</a> balance chart with a 💰 marker and subtle green band so you can see upcoming income at a glance.</li>
+                    <li>The category is automatically set to <strong>Salary</strong>.</li>
+                </ul>
+
+                <h6>Deleting a Salary</h6>
+                <p class="mb-0">Deleting a salary removes all future unpaid transactions for that income source. Past transactions remain in your history for accurate record-keeping.</p>
+            </div>
+        </div>
+
        @* ── Categories ── *@
        <div class="card mb-4" id="categories">
            <div class="card-header">
@@ -120,6 +153,7 @@
                    <li><strong>Add a category</strong> — Enter a name and pick an emoji icon from the icon picker.</li>
                    <li><strong>Edit</strong> — Click the Edit button on a category card to change its name or icon.</li>
                    <li><strong>Delete</strong> — Removes the category. Transactions using it will become uncategorised.</li>
+                    <li><strong>Default categories</strong> — A set of built-in categories (Groceries, Salary, Rent / Mortgage, etc.) are created automatically and shown with a <strong>Default</strong> badge. These cannot be edited or deleted.</li>
                </ul>
                <p class="mb-0">Categories are optional — you can assign them to transactions to get better insight into your spending patterns.</p>
            </div>
@@ -175,6 +209,7 @@
                <ul class="mb-0">
                    <li>Use the Dashboard <strong>+ Add</strong> button for rapid entry — the modal stays open after each save so you can batch-add transactions.</li>
                    <li>Set up recurring transactions for regular bills and income to keep your upcoming view accurate.</li>
+                    <li>Use the <a href="/salary">Salary</a> page for regular pay — it is protected from accidental deletion and highlights paydays on the chart. Use the <strong>90d</strong> or <strong>1y</strong> window to plan ahead.</li>
                    <li>Assign colours to your accounts to easily distinguish them on the chart and in transaction lists.</li>
                    <li>Hover over elements for tooltips with additional context throughout the app.</li>
                    <li>Click your account balances in the sidebar to quickly navigate to account management.</li>
@@ -193,6 +228,7 @@
                <a href="/help#dashboard" class="list-group-item list-group-item-action">📊 Dashboard</a>
                <a href="/help#accounts" class="list-group-item list-group-item-action">🏦 Accounts</a>
                <a href="/help#transactions" class="list-group-item list-group-item-action">💸 Transactions</a>
+                <a href="/help#salary" class="list-group-item list-group-item-action">💰 Salary</a>
                <a href="/help#categories" class="list-group-item list-group-item-action">🏷️ Categories</a>
                <a href="/help#reports" class="list-group-item list-group-item-action">📈 Reports</a>
                <a href="/help#settings" class="list-group-item list-group-item-action">⚙️ Settings</a>