Skip to content

docs: complete page-by-page handbook#197

Merged
Sagargupta16 merged 1 commit into
mainfrom
docs/handbook
Jul 1, 2026
Merged

docs: complete page-by-page handbook#197
Sagargupta16 merged 1 commit into
mainfrom
docs/handbook

Conversation

@Sagargupta16

Copy link
Copy Markdown
Owner

Adds docs/HANDBOOK.md — a detailed walkthrough of every page and settings section: what each card, chart, metric, toggle, and setting shows, with the exact formula and data source for each.

What's in it

  • All 23 surfaces documented: Home, Upload & Sync, Transactions, Dashboard, Spending/Income Analysis, Income/Expense Flow, Budgets, Trends & Forecasts, Period Comparison, Year in Review, Net Worth, Investment Analytics, SIP Projection, Returns, Tax Planning, GST, FIRE, Goals, Subscription Tracker, Bill Calendar, Anomaly Review, and Settings (every section + what each setting controls).
  • Each section: Route, Reads from (the backend endpoint/hook), What's on the page (every element with its Computed: formula + inputs), and Controls & notes (time filter, toggles, deep-links, empty states, preference coupling).

Why it's also a consistency reference

Generated from the live frontend source after the v2.17 server-side-aggregation migration, so each section names the endpoint feeding it — making clear which metrics are computed once on the server (consistent across pages) vs still computed client-side (Tax, GST, net-worth/XIRR projections, CFP health score).

Cross-linked from README, CLAUDE.md, and PAGES.md (kept as the shorter data-catalog).

A detailed walkthrough of every page + settings section: what each card,
chart, metric, toggle, and setting shows, with the exact formula and data
source for each. Covers all 23 surfaces (Dashboard, Spending/Income, Trends,
Net Worth & investments, Tax/GST, FIRE/Goals, recurring/alerts, Settings).

Generated from the live frontend source post-v2.17 migration, so each
section's 'Reads from' line names the backend endpoint/hook feeding it --
doubles as a data-consistency reference (which metric is computed once on the
server vs still client-side). Cross-linked from README, CLAUDE.md, and PAGES.md
(which stays as the shorter data-catalog).
@sonarqubecloud

sonarqubecloud Bot commented Jul 1, 2026

Copy link
Copy Markdown

@Sagargupta16 Sagargupta16 merged commit 9619c5b into main Jul 1, 2026
8 checks passed
@Sagargupta16 Sagargupta16 deleted the docs/handbook branch July 1, 2026 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant