Commit Graph

34 Commits

Author SHA1 Message Date
Jonathan Fang
af19c9d239 Reorganizing documentation since SimpleFIN will be officially released #2 (#459)
- removed simplefin from experimental tab
- added mention of simplefin in bank-sync
- split bank-sync into gocardless and simplefin
- created dropdown for bank-sync
- proofreaded punctuation & image alignment in gocardless and simplefin
guides

Fixes https://github.com/actualbudget/docs/issues/452,
https://github.com/actualbudget/docs/pull/453 and fixes
https://github.com/actualbudget/docs/issues/454

I'm not sure why https://github.com/actualbudget/docs/issues/458 got
closed, so I'm making a new one here.

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-10-03 18:12:23 +01:00
Ruben Olsen Lærk
0b8f267f9b Reorganising the menu items (#429)
1. Moved _Filtering_ from _Reports & Filters_ to _Accounts &
Transactions_ as it's are more natural place to have the filter
documentation.
2. Renamed _Reports & Filters_ to just _Reports_
3. Moved _Schedules_ out of _Budgeting_ to better reflect the sidebar
items in the program.
4. Based on feedback from Michael Burnside on Discord, moved the
envelope budgeting docs higher up in the menu. What he wrote on Discord:
_I think the Envelope Budgeting doc should be moved up in the list. It's
important to understand the method and the "Why" first, so that users
can make sense of the tool and the "how". I know there's a link at the
top of the Starting Fresh article, but people tend to go top to bottom
in the contents (if they're reading at all)._
5. Moved _A Tour of Actual_ out of _Getting started_ as it's marketing
and not getting started with the program.
6. Moved _Starting Fresh_ higher up to differentiate between the tech
stuff and the why stuff.

**There is no change in content - just trying to make the menu a better
place to navigate**

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-09-15 13:50:28 +02:00
wdpk
f13cc304ed basics of text style guide for consistent tone when writing. (#398)
add some basic guidelines about how to write the docs so a shared voice is heard when using the documentation.

---------

Co-authored-by: Zeus\Herb <herb@win.dows>
Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-09-13 08:36:16 +01:00
Julian Wachholz
6772a1c7d1 Add i18n documentation (#431)
Initial draft for contribution guidelines on how to prepare Actual for
i18n and l10n.

Please do add your feedback!
2024-08-15 09:54:33 -07:00
Robert Dyer
baba070baf Update report budget docs (#425)
First, the way to enable it has changed so that is updated.

Second, the UI now calls it "tracking" and "envelope" budgeting, so the
text and filenames were updated to reflect the new "tracking" name.
2024-08-08 20:27:23 +01:00
Ruben Olsen Lærk
4356a23f9c Revamp of A tour of actual (#402)
The current Tour was lacking for people curious about what Actual looks
like, without going into "full teaching manual mode".

What I have done:

- Consistent screenshots
- Added some explanatory text and links to the actual manual pages

I am fully aware that there is a fine line between some of these pages
and manual pages.

Anyway - we should now have something to show the YNABers and MINTers of
the world :-)

Ideally, we should have a video introduction as the "tour" - but given
how much change we have in the program, this would kill the poor guy/gal
who wants to maintain such a video.

PS: I go on vacation on Saturday July 13th - so any changes I am not
able to do after that time.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-12 13:42:02 -07:00
Ruben Olsen Lærk
2ba87486a6 Roadmaps for new users (#395)
I have added a _Roadmaps for new users_ to help people decide on their
next step. The roadmaps are primarily aimed at non-technical people.

I saw the reason for doing this after getting a few questions for
non-techies people I know about "ehhh... where do I start?" ... "I did
install the desktop software, how to get this into my cell phone", etc.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-09 11:36:13 -07:00
Ruben Olsen Lærk
d54bdffc6b A go at Starting fresh (#389)
We now have quite a few changes - not only moving the *generic envelope
budget* stuff out.

In short:
* Added section on handling cash. The idea behind this is to give people
that are new to this kind of budgeting, an easy idea on what to do with
cash. Even seasoned Zero-Summers can forget about this simple trick :-)
* Amended Setting up your Budget Categories with a small tip.
* Added sub section Group Your Expense Categories. I have guided a lot
of people on using Zero-Sum software (Ynab, Financier - and now Actual)
- and the grouping I propose have shown to help people to not touch
category money they should not touch.
* Assigning Available Funds is a complete rewrite - this is "Tips" we
removed from the envelope-budget.md file - I will add a link back into
the getting-started document when both PRs has been done.
* Added a section on finding your budget number if you do not want, or
can use historical data
* Keep Budgeting was amended 
* Added a header before text on next step.

OBSERVATIONS: I think this document is too big - and it should be split
into it's 5 parts (+ introduction).

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-05 13:39:39 -07:00
Ruben Olsen Lærk
a6f3bcafe4 Created page on the topic - How envelope budgeting works (#386)
I have added this page because I think the software used for envelope
budgeting should definitively have some documentation on how to actually
do envelope budgeting.

---------

Co-authored-by: Ruben Olsen Lærk <ruben.olsen@dnb.no>
2024-07-05 11:10:29 -07:00
wdpk
5424d6b402 Create section on restarting your budget without removing transactions (#383)
Fixes #362 

Taken from Teprifer#muddledjellyfish's answer on Discord server.

---------

Co-authored-by: Zeus\Herb <herb@win.dows>
2024-07-05 10:55:08 -07:00
youngcw
552126589f custom reports no longer experimental (#375)
Update the custom reports page and move it out of experimental. Misc
other tweaks to be consistent about reports.
2024-07-01 13:02:49 -07:00
Joseph Livecchi
3311ea58fd Added documention about the header authentication (#341)
Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: Robert Dyer <rdyer@unl.edu>
2024-06-03 07:06:37 -07:00
Robert Dyer
d90aeffb91 Add reset password doc to the sidebar (#358)
<img width="286" alt="image"
src="https://github.com/actualbudget/docs/assets/1115390/5b558700-4589-4ebd-a809-17bf0355cb0c">
2024-05-25 10:50:19 -07:00
shall0pass
90e3ffe539 Remove full sync migration documentation (#320)
This PR removes the migration page from Full Sync to Simple Sync.

This page was needed 16 months ago when a breaking change was merged to
resolve issues with the sync algorithm. Given that there have been over
16 releases since this change, most users will never encounter this
issue.
2024-02-27 10:49:11 -07:00
Redbox3070
e56103d456 Create page for custom reports (#316)
Custom reports documentation, pictures are still missing.

---------

Co-authored-by: Teprifer <34882928+Teprifer@users.noreply.github.com>
2024-02-21 12:31:49 -07:00
Matiss Janis Aboltins
6878ca5365 📝 feature flags policy (#317) 2024-02-21 18:17:03 +00:00
Dan D
7968c18bcb Add Experimental SimpleFIN Sync to Docs (#312)
Added a new page in the docs under "Experimental", for SimpleFIN Sync. 

I used the existing GoCardless page as a starting point.
2024-02-06 18:14:48 -07:00
Paul Gauntlett
3ef647b240 Update Contributor Section - Side Bar Order (#298) 2024-01-05 22:01:54 +00:00
Peter
941838c045 add reverse proxy config documentation (#267)
Hey, since I've been using Actual via Traefik for a few days now, I took
the time to add a little bit to the documentation in that regard. I hope
it fits so far. Please feel free to comment/improve anything.
2023-12-03 13:31:18 -07:00
youngcw
36969de9e3 guide for starting fresh (#279)
Depends on #278.
Fixes #251

This adds a dedicated guide for those that are starting fresh with
Actual and aren't familiar with zero-sum budgeting. It is a step by step
that points to the existing pertinent docs pages with additional
direction.

---------

Co-authored-by: shall0pass <20625555+shall0pass@users.noreply.github.com>
Co-authored-by: Matiss Janis Aboltins <matiss@mja.lv>
2023-12-03 13:29:13 -07:00
Shazib Hussain
8a90292f97 Adding some contribution guidelines (#277) 2023-11-27 19:42:23 +00:00
Matiss Janis Aboltins
39a8f94931 [WIP] Actual Budget Vision (#213) 2023-11-26 19:36:43 +00:00
youngcw
a7e862acbb Community Projects page (#278)
This adds a page that calls out useful and interesting community
projects that integrate with Actual. There are only a few that I know of
right now, but we can add any later that come up.
2023-11-22 13:03:35 -07:00
Matiss Janis Aboltins
9c5e4bc7a1 📝 new core contributor guide (#256)
New Core Contributor Guide

Information that is useful to know when joining the team.
2023-08-10 17:22:31 +01:00
Johannes Löthberg
5787ae51e5 Rewrite managing credit cards page (#252) 2023-07-27 09:13:28 -05:00
shall0pass
f0e67d71d4 Spellchecker CI (#228) 2023-07-15 10:41:33 -04:00
Michael Gillett
ce8ea5a534 created filters & reports category (#238) 2023-07-12 14:30:50 -04:00
Jed Fox
413c9f7919 Add a funding policy document (#217) 2023-06-29 14:23:56 -04:00
Shazib Hussain
741460fd10 Adding architecture details (#211)
Maybe these notes should form part of an existing page, but I wanted to
put some notes in about the web worker/websockets nuance and clarify the
whole frontend/backend thing as it confused me a bit at first.

Perhaps this page could be a stub for adding more 'technical' details as
we go. (stick a 'more coming soon' on the bottom?)

Or maybe it should just be called 'Technical Details'

---------

Co-authored-by: Jed Fox <git@jedfox.com>
2023-06-19 19:28:12 -04:00
Shazib Hussain
f92c760d8d Updating project information docs (#207) 2023-06-18 11:00:26 -04:00
Matiss Janis Aboltins
c559e6b68c 📝 (nordigen) move bank-sync docs away from experimental (#208) 2023-06-18 10:58:49 -04:00
Rich Howell
7fa3a13783 Contributing to actual budget (#203) 2023-06-14 18:07:12 +01:00
Jed Fox
268544b6d7 Rename budgeting/howitworks.md to index.md (#202)
This matches the other pages that have child pages.
2023-06-14 07:33:05 +01:00
Jed Fox
899801ab0c Move the docs back to /docs, add in a version of the homepage (#193)
https://deploy-preview-193--zingy-bonbon-b1b286.netlify.app

---------

Co-authored-by: Rich Howell <github@codenameowl.com>
2023-06-13 05:51:08 +01:00