| title | Finance Guru repository documentation |
|---|---|
| description | Contributor, operational, and source-reference material |
| category | root |
Until the GitHub Wiki home
is published, authenticated, and inspected in its rendered form, this docs/
directory and the README are the canonical reader-facing documentation entry
points. This directory also contains the source material maintainers need to
verify, operate, and evolve the project without duplicating the planned Wiki's
user-guide pages.
| Need | Source |
|---|---|
| Install or develop the checked-in engine | Setup |
| Find a verified command entry point | CLI reference |
| Configure optional provider credentials | API keys |
| Connect SnapTrade or SimpleFIN live sync | Live sync credentials |
| Resolve an environment or provider failure | Troubleshooting |
| Understand contribution boundaries and checks | Contributing |
| Review data-handling boundaries | Privacy |
| Understand planned standalone-app work | Vision |
| Verify a canonical Wiki claim | Wiki evidence ledger |
- Runbooks cover recurring operational procedures.
- Architecture decisions preserve decisions that remain relevant to the checked-in repository.
- Solutions and reports are historical evidence, not product guarantees. Check their dates and the current code before reusing a claim.
- Historical planning material, when present in a branch or release, does not describe released or implemented behavior unless current code proves it.
When a change affects setup, commands, data storage, privacy, testing, or release status, update the corresponding Wiki page and this repository source material as needed. The Wiki's maintenance page maps changes to pages and records the evidence standard.