> [!NOTE]
> Important This will need a decent amount of testing of images, links,
sidebar, rss feed, etc
Upgrading Docusaurus to the latest.
- We can now use Mermaid diagrams
- It's supposed to have better performance
- It's actively supported (v2 wasn't)
Throughout this PR you'll notice
- Formatting updates (they are required for the build process)
- Some CSS updates - some default styling was changed in the plugins we
use. The updates I've made should make the style near identical to
what's currently live
- Some updates & fixes to bring our docs in line with the v3 way of
writing
Overall, the docs should look the same.
## Known issues:
- The top page nav is flickering when clicking links in the top page
nav. It's happening on the main Docusuarus website
https://docusaurus.io/blog
- If we upgrade we'll have to accept it until they fix it on their end
Add documentation for notes tagging and how to change their colors.
---------
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
- Introduced a new document for Cursor IDE, detailing setup, automation,
and custom rules.
- Updated the new core contributors guide to include a link to the
Cursor IDE documentation for additional tips.
Adding a page to Using Actual/Budgeting to demonstrate how to implement
multi-currency using Rule Templates.
---------
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
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>
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>
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.
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>
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>
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>
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>
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.
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.
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>
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.
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>
