Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
glorat committed Jan 16, 2024
1 parent d6e2d08 commit c968553
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
17 changes: 16 additions & 1 deletion client/public/md/faq.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
##### FAQ
TODO:

## What inspired the design?
The design is heavily inspired by [beancount](https://beancount.github.io/) and other text based accounting systems. These systems keep your data in an open human editable format that keeps the user in control of their data by prevent lock-in to any one provider. For example, gainstrack provides an export to beancount format.

The UI is heavily inspired by [fava](https://beancount.github.io/fava/) but by using more web technologies and being just more than a reporting tool, gainstrack can do much more

## Any known issues?

### Feb'20
- While the UI editor can be used for submitting new entries, amendments or deletions can only be done via the text editor

### Dec'19
- Income/Expenses/Liabilities are counterintuitively affected by future market prices, rather than retaining their original cost basis

### Nov'19
- Liabilities are not supported in reports yet
19 changes: 4 additions & 15 deletions client/public/md/welcome.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Welcome to gainstrack
## Why gainstrack?

Gainstrack's vision is for individuals to be have control over their own finances through information and insights on their networth

Gainstrack's mission is to provide cutting edge tools and information over finances on an open platform
Gainstrack's aim is for individuals to be have control over their own finances through information and insights on their networth

Beyond knowing your networth, it tracks your wealth across multiple accounts in multipe currencies, helping you track your path to financial independence

Expand All @@ -16,17 +14,8 @@ For more information on how Gainstrack works, see the [help pages](/docs/help)

## Getting started

No registration required - maintain your own Gainstrack finances file on your machine and import to the website as necessary using the import/export capability

The optional registration allows your gainstrack data to be saved on our backend
Creating an account allows your gainstrack data to be saved and updated with our UI tools or in-built editor

## Errata
## Anonymous mode

### Feb'20
- While the UI editor can be used for submitting new entries, amendments or deletions can only be done via the text editor

### Dec'19
- Income/Expenses/Liabilities are counterintuitively affected by future market prices, rather than retaining their original cost basis

### Nov'19
- Liabilities are not supported in reports yet
No registration required - maintain your own Gainstrack finances file on your machine and import to the website as necessary using the import/export capability

0 comments on commit c968553

Please sign in to comment.