Skip to content

docs: add user manual and correct supported banks list - #156

Open
rprabhat wants to merge 5 commits into
mainfrom
docs/user-manual
Open

rprabhat wants to merge 5 commits into
mainfrom
docs/user-manual

Conversation

@rprabhat

@rprabhat rprabhat commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds a user-facing manual for Sensible Folio and corrects documentation inaccuracies.

Changes

  • Add docs/user-manual.md — a complete user manual covering:
    • Feature list at a glance (portfolio & investments, income & tax, bank & broker integration, planning & insight, platform & privacy)
    • How to manage your personal finances (tracking investments, imports, Bank Connect, performance, income, net worth, goals, tax, AI assistant, addons)
    • How to configure and use Folio (install, first run, Settings walkthrough, activity-type reference, troubleshooting & FAQ)
  • README.md — add a Documentation section linking the manual + related docs; replace the inaccurate Supported Banks list (previously listed Westpac/NAB/Macquarie, which are not supported) with the verified Bank Connect connectors.
  • docs/getting-started.md — cross-link the new user manual from Next Steps.

Accuracy

The bank/broker list and import formats in the manual are grounded in source:

  • Bank Connect connectors: CommBank (CBA), ANZ, ING, Bank of Melbourne, Beyond Bank; brokers: Interactive Brokers (Beta); coming soon: CommSec, Sharesies, SelfWealth, Stake.
  • Import formats: CSV, OFX, QIF.
  • Bank Connect is desktop-only (web build stubs it out).

Verification

  • npm run lint → 0 errors (1509 style warnings, tolerated)
  • npm run build → tsc && vite build succeeds

Docs-only change; no runtime code touched.


CI fixes (3bf7c11)

This PR also resolves pre-existing CI failures that surfaced on the PR merge ref (main + branch):

  • Type-check (lint-and-test): migrated useAssistantApi/useAssistantState to useAui/useAuiState in the ai-assistant components. Main upgraded @assistant-ui/react to 0.15.22, which removed those deprecated aliases; PR merge refs inherit main's lockfile, so CI failed even though this branch pins 0.12.24.
  • Rust (clippy): #[allow(clippy::double_must_use)] on MarketDataProvider and sort_by_key in the market-data providers.
  • CodeQL: removed python from the analysis matrix (no Python sources; the job failed during Python extraction).

- Add docs/user-manual.md: user-facing manual covering the feature list,
  how to manage personal finances, and how to configure and use Folio
- README.md: link the new documentation set and replace the inaccurate
  Supported Banks list with the verified Bank Connect connectors
- docs/getting-started.md: cross-link the user manual from Next Steps
- ai-assistant: migrate useAssistantApi->useAui, useAssistantState->useAuiState
  (@assistant-ui/react 0.15.22 on main removed the deprecated aliases; PR merge
  refs inherit main's lockfile, so PR CI type-check failed on the merge ref even
  though this branch pins 0.12.24 where the aliases still exist)
- market-data: allow clippy::double_must_use on MarketDataProvider async_trait;
  use sort_by_key instead of sort_by(..cmp..) (clippy::unnecessary_sort_by)
- codeql: drop python from the analysis matrix (no python sources; job failed
  during python extraction)
- crate-level allow for clippy::double_must_use (203 errors generated by
  async_trait on returned futures, same pattern as the market-data fix)
- sort_by_key/sort_by_key+Reverse instead of sort_by(..cmp..) (7x unnecessary_sort_by)
- drop redundant borrows in format args (4x useless_borrows_in_formatting)
- drop needless closure borrow (1x needless_borrows_for_generic_args)
- drop redundant into_iter() before stream::iter (1x useless_conversion)
main's lockfile bumped prettier 3.8.1 -> 3.9.9, which reformats ~180 files;
the PR Check workflow's format:check gate failed on all of them.
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.

3 participants