A local-first personal finance app
Updates to the sidebar layout & content (#89)
Jed Fox7285753e2dc5
diff --git a/docs/Budgeting/rules/rules-custom.md b/docs/Budgeting/rules/rules-custom.mdindex a6322bcb01..e72f83e3d0 100644--- a/docs/Budgeting/rules/rules-custom.md+++ b/docs/Budgeting/rules/rules-custom.md@@ -2,9 +2,8 @@title: 'Supercharge your Budget'----[discord]: https://discord.gg/8JfAXSgfRf-This page has examples of custom rules that some of our users have found useful for their own budgets. If you have any custom rules you're proud of, let the [Discord][discord] group know or submit an issue or PR to the Actual Documentation GitHub repository.+This page has examples of custom rules that some of our users have found useful for their own budgets. If you have any custom rules you're proud of, click the “Edit this page” button below to propose adding them to this page [tell us about them](/Contact.md)!**Q: How do I set a default account when I add transactions?**diff --git a/docs/Contact.md b/docs/Contact.mdnew file mode 100644index 0000000000..daf58b95b0--- /dev/null+++ b/docs/Contact.md@@ -0,0 +1,15 @@+---+title: Contacting Us+---++:::note++Actual is an open source app, which means that nobody is being paid to work on it, and everything is happening in our free time. Please keep that in mind when asking us for help :)++:::++We are happy to help out with any issues you encounter with getting Actual running or using it. There are a few ways to get help:++- For questions about installing or using Actual, [join our Discord](https://discord.gg/8JfAXSgfRf) and make a new post [in the `#support` channel](https://discord.com/channels/937901803608096828/1027966372862505021)+- If you’d like to report a bug or request a feature, [open a new issue on GitHub](https://github.com/actualbudget/actual/issues/new/choose). If you don’t have a GitHub account, you can create one for free. Alternatively, you can post a message in Discord and we can create the issue for you.+- If you see a problem with this documentation website, you can click the “Edit this page” button at the bottom of the page in question and then click the “edit” button on the GitHub page that opens to make edits directly from your browser. (See a [step-by-step guide here](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files)). If you don’t have a GitHub account, it’s free to create one, or you can tells us about the problem in Discord and we can make the edit for you.diff --git a/docs/Developers/API.md b/docs/Developers/API.mdindex ac0c9906cc..362f7b8460 100644--- a/docs/Developers/API.md+++ b/docs/Developers/API.md@@ -1,3 +1,7 @@+---+title: API Reference+---+import { types, objects, PrimitiveTypeList, PrimitiveType, StructType, Method, MethodBox } from './types';import APIList from './APIList';diff --git a/docs/Developers/Building-Windows.md b/docs/Developers/Building-Windows.mdindex 99366a6f00..3ce157bcfe 100644--- a/docs/Developers/Building-Windows.md+++ b/docs/Developers/Building-Windows.md@@ -1,5 +1,5 @@----title: 'How To Build Browser For Windows'+title: 'Building on Windows'---Many of the build scripts are bash scripts and not natively invokable in Windows. To solve this, you can build the project using Git Bash.@@ -10,12 +10,12 @@ Many of the build scripts are bash scripts and not natively invokable in Windows5. Using Git Bash, change to the the root of this repo6. From inside the bash shell, run `yarn install`7. From still inside the shell, run `yarn start:browser`-8. Open your browser to `localhost:3001`+8. Open your browser to [http://localhost:3001](http://localhost:3001)-# How to build electron for Windows+## How to build the Electron app on Windows1. Follow steps 1 - 6 above.2. Run `yarn start`. If you get an error about bundle.desktop.js, just CTRL+C and rerun `yarn start`.3. If you get an error from electron, run `yarn rebuild-electron` and rerun `yarn start`;-## rsync: command not found+## `rsync: command not found`If you run into this error, you will need to install the rsync binary to Git Bash. Follow the [directions here](https://prasaz.medium.com/add-rsync-to-windows-git-bash-f42736bae1b3).\ No newline at end of filediff --git a/docs/Developers/preview-builds.md b/docs/Developers/preview-builds.mdindex a6f1629893..9e435395af 100644--- a/docs/Developers/preview-builds.md+++ b/docs/Developers/preview-builds.md@@ -11,5 +11,5 @@ Once you have the number of the pr navigate to the following URL https://deploy-This will load directly on Netlify where you will be able to preview the changes in that pull request without the need to clone the specific branch.:::info-There is no sync server on preview builds so when asked "Where's the server" select "Don't use a server"+There is no sync server on preview builds so when asked "Where's the server" select "Don't use a server." Alternatively, you can use your own self-hosted server. You should exercise caution when doing using a server with preview builds because they are much more likely to have bugs that could damage your budget. Consider running a separate local server for preview builds.:::diff --git a/docs/Developers/project-layout.md b/docs/Developers/project-layout.mdindex 0e5e799d5f..4000be6834 100644--- a/docs/Developers/project-layout.md+++ b/docs/Developers/project-layout.md@@ -2,9 +2,9 @@title: 'The Actual Project Structure'----Actual is made up of lots of different *packages* in this article we are going to try and explain how each of them fits together to form the project you know as Actual Budget.+Actual is made up of lots of different *packages*. This article covers how they all fit together to form the project you know as Actual Budget.-All of the actual repositories can be found in the [Actual Budget](https://github.com/actualbudget) organization on GitHub, within that organization you will then find the following repositories+All of the repositories can be found in the [Actual Budget](https://github.com/actualbudget) organization on GitHub, within that organization you will then find the following repositories* [Actual](https://github.com/actualbudget/actual)* [Actual Server](https://github.com/actualbudget/actual-server)@@ -14,7 +14,7 @@ All of the actual repositories can be found in the [Actual Budget](https://githu## Actual-This repository hold all of the front end code for the Actual Budget application, it also holds all the packages for other parts of the application too such as the desktop application and importers.+This repository holds all of the front end code for the Actual Budget application, along with the syncing engine and the importers for YNAB4 and YNAB5.```├── actual@@ -26,7 +26,6 @@ This repository hold all of the front end code for the Actual Budget application└── import-ynab5└── loot-core└── loot-design- └── mobile└── node-libofx...│@@ -53,15 +52,6 @@ The development version of the importer for nYNAB into Actual.### Loot Design--### Mobile--This packages holds the source code for the Android & iOS applications.--:::note-These applications are no longer supported and are being replaced with a responsive first version of Actual Web-:::-### Node Libofx## Actual Serverdiff --git a/docs/Getting-Started/sync.md b/docs/Getting-Started/sync.mdindex f8834f8193..4f59149934 100644--- a/docs/Getting-Started/sync.md+++ b/docs/Getting-Started/sync.md@@ -6,9 +6,9 @@ Actual is a different kind of app. Instead of storing all of your data on the inWe don't want to throw away the internet though. It's too useful. When your data is stored in the cloud, you can access it from any device easily, and you never have to worry about losing your data in case you drop your laptop or phone into a lake.-That's why we automatically sync all of your data to the cloud in the background. You get the best of both worlds: all data is local by default, but if internet is available, your data is seamlessly backed up and synced to all other devices. This is the opposite of most apps which heavily rely on the internet to be available.+That's why we automatically sync all of your data to your selected server in the background. You get the best of both worlds: all data is local by default, but if internet is available, your data is seamlessly backed up and synced to all other devices. This is the opposite of most apps which heavily rely on the internet to be available.-For the super privacy-focused, it even allows for your data to be [end-to-end encrypted](#End-to-end encryption) since all your server is doing is passing around changes.+For the super privacy-focused, it even allows for your data to be end-to-end encrypted so that all your server is doing is passing around changes.## Getting started@@ -67,15 +67,13 @@ After resetting, all other devices are now out-of-date. What happens when you trWhen Actual detects a problem during syncing, you will see a notification with details and actions to solve the problem. Below are all the notifications you might see, with some greater detail about them.-**You will rarely see these messages**, and if you do Actual will guide you through how to fix the problem. If you are still having problems, [open an issue](https://github.com/actualbudget/actual/issues) or join the [Discord](https://discord.gg/8JfAXSgfRf).+**You will rarely see these messages**, and if you do Actual will guide you through how to fix the problem. If you are still having problems, please [reach out to us](/Contact)### This file is not a cloud file-A "cloud file" is a file that has been registered with our server and is currently syncing data. Sometimes a file hasn't been registered yet so it can't send any data to sync.+A "cloud file" is a file that has been registered with your server and is currently syncing data. Sometimes a file hasn't been registered yet so it can't send any data to sync.-Usually this happens when a new file is created when there is no internet connection. In that case, it creates a local file but our server doesn't know anything about it. When you are online you need to register it.--Local files without syncing are not supported. Even if you don't sync to multiple devices, syncing to our server creates a backup of your data and you never have to worry about losing it. If you are worried about privacy, enable end-to-end encryption.+Usually this happens when a new file is created when there is no internet connection. In that case, it creates a local file but the server doesn't know anything about it. When you are online you need to register it.### Syncing has been reset on this cloud file@@ -94,7 +92,3 @@ Unfortunately, Actual detected an inconsistency in your synced data. This only h### Update requiredWhile syncing, your device received data that it couldn't apply because your version of Actual is out-of-date. You need to update Actual and it will then sync successfully.--### Actual has updated the syncing format--You will see this when upgrading to version 0.0.120. The internal syncing format has changed and you need to do a [sync reset](#what-does-resetting-sync-mean).diff --git a/docs/Getting-Started/using-actual/index.md b/docs/Getting-Started/using-actual/index.mdnew file mode 100644index 0000000000..2ba09c48ca--- /dev/null+++ b/docs/Getting-Started/using-actual/index.md@@ -0,0 +1,41 @@+---+title: A Tour of Actual+---++This article covers the first steps you’ll likely want to take when you first open Actual. The other entries in this section of the sidebar cover different parts of the interface in more detail.++### Add a bank account++When first opening the app, it will ask you to add a bank account. Fill out the form and click “Create.” You can add accounts later by clicking the "Add Account" button in the sidebar. If you’d like, you can export some recent transactions from your bank and [import them into Actual](/Accounts/Transactions/importing-trans/) so you have some data to work with right away. But Actual will also work just fine if you don’t import any transactions from the past.++### Set a budget++Once you’ve added your first account, you can navigate to the Budget page by clicking its link in the sidebar. Once you’re there, you can choose categories you’d like to use for budgeting.. Some basic categories have been added for you, but you can add more or remove the default ones by clicking the arrow on a category group or a category.++Create your first budget by entering amounts into the “budgeted” column of the categories you want to track. Your starting balance will be available as money to budget (see [how budgeting works](/Budgeting/howitworks/)).++### Check back throughout the month++That's it! After you've made some more purchases, check back and [import your transactions](/Accounts/Transactions/importing-trans/). After categorizing them, you can see how your spending has impacted your budget.++Related reading: [how budgeting works](/Budgeting/howitworks/), [managing categories](/Budgeting/categories/)++### Useful Links++Below is a list of useful links related to Actual Budget.++- [The open source announcement](https://actualbudget.com/open-source)+- [GitHub for Actual](https://github.com/actualbudget) - The source code for Actual, a local-first personal finance tool.+- [GitHub for Actual Server](https://github.com/actualbudget/actual-server) - The syncing server with web client included . All you need to run Actual.+- [GitHub repository of releases of Actual and Actual packages](https://github.com/actualbudget/releases)+- The official Docker image:+ [https://hub.docker.com/r/jlongster/actual-server](https://hub.docker.com/r/jlongster/actual-server)++### Guides++- [Deploying Actual (youtube video)](https://www.youtube.com/watch?v=6ho_oA4MwXo) credit Marc Seitz+- [YNAB4 User Guide](https://hananhazime.files.wordpress.com/2015/12/ynab-print.pdf)++### Misc++- [James talking about Actual on the Changelog Podcast](https://changelog.com/podcast/495)diff --git a/docs/Installing/Docker.md b/docs/Installing/Docker.mdindex 3454f1ead9..da86f54e98 100644--- a/docs/Installing/Docker.md+++ b/docs/Installing/Docker.md@@ -7,30 +7,26 @@ sidebar_position: 2Actual is also available as a Docker image ready to be run in your own custom environment.-* [Docker Hub](https://hub.docker.com/r/jlongster)-* [Github Registry](https://ghcr.io/actualbudget/actual-server)+* [Docker Hub](https://hub.docker.com/r/jlongster/actual-server)+* [GitHub Registry](https://ghcr.io/actualbudget/actual-server)## Docker TagsWe publish a number of tags to the official repository now so that users who want to get the latest bleeding edge changes can do that without having to wait for the latest image to be updated. Details of the available tags are below.-:::note-[SemVer](https://github.com/semver/semver/blob/master/semver.md) relates to the Semantic Version number-:::+### `latest` Tag-### Latest Tag+The `latest` tag points to the most recent official release of Actual. This is the recommended tag to use for most users.-Auto-updated to point to the most recent semver build (see the [workflow docs](https://github.com/marketplace/actions/docker-metadata-action#typeedge)) 👈 this is for people who want the stable build.--* latest-* latest-alpine - Based on Alpine Linux, which is tiny so great for low powered devices.+* `latest`+* `latest-alpine` - Based on Alpine Linux, which is tiny so great for low powered devices.-### Edge Tag+### `edge` Tag-This tag reflects the last commit of the active branch on your Git repository.+The `edge` tag is updated every time a commit is pushed to the `master` branch. This is the recommended tag to use for users who want to get the latest changes. Note that `actual-server` will still use the latest official release of the web UI even when deploying from `edge`-* edge-* edge-alpine - Based on Alpine Linux, which is tiny so great for low powered devices.+* `edge`+* `edge-alpine` - Based on Alpine Linux, which is tiny so great for low powered devices.## Launch container using Docker Compose@@ -68,7 +64,7 @@ $ docker run --pull=always --restart=unless-stopped -d -p 5006:5006 -v YOUR/PATH`-p 5006:5006` -- sets the port to access Actual. (HOST PORT:DOCKER PORT)-`-v YOUR/PATH/TO/DATA:/data` -- tells the container where to store your budget data. This persists the data on your hard disk so it isn't lost if you remove the container. Change the current value to a folder on your host computer.+`-v YOUR/PATH/TO/DATA:/data` -- tells the container where to store your budget data. This persists the data on your hard disk so it isn't lost if you remove the container. Change the current value to a folder on your host computer. The server will create `server-files` and `user-files` subfolders at this location.`--name my_actual_budget` -- gives your new docker container a namediff --git a/docs/Installing/Local/your-own-machine.md b/docs/Installing/Local/your-own-machine.mdindex 7e67738440..a6416a56c0 100644--- a/docs/Installing/Local/your-own-machine.md+++ b/docs/Installing/Local/your-own-machine.md@@ -2,15 +2,17 @@title: 'Local Installation'----The easiest way to get Actual running is to use the [actual-server](https://github.com/actualbudget/actual-server) project.+The easiest way to get Actual running locally is to use the [actual-server](https://github.com/actualbudget/actual-server) project.Actual Server is the server element of Actual that is used for syncing changes across devices, and it comes with the latest version of Actual Web.-## Getting Started+## Pre-requisites-As outlined in the [overview](/Installing/overview.md) you need to make sure the following is installed on your machine before starting.+Actual Server currently requires Node.js v16. If you don’t have Node.js installed, you can download the latest version of Node.js 16 from the [Node.js website](https://nodejs.org/en/download/releases/) (search for “16” to find the right version). If you already have Node.js installed, consider using a tool like [`nvm`](https://github.com/nvm-sh/nvm) or [`asdf`](https://asdf-vm.com) to install and manage multiple versions of Node.js.-[NodeJS](https://nodejs.org/en/) version 14 or greater, NodeJS has documentation on how to install it on your own machine, [Yarn](https://yarnpkg.com/) you can install this using NPM, however if you only just installed NodeJS you may need to restart your terminal first before running the below command.+You’ll also need to have Git installed. The Git website has [instructions for all supported operating systems](https://git-scm.com/download).++Next, you’ll need to install `yarn`, which is the package manager that Actual uses. You can install it using the following command:```jsnpm install --global yarn@@ -38,14 +40,16 @@ yarn install## Running Actual-Now that Actual is *installed* we can start it by issuing the following command+Now that Actual is installed, start the server by running the following command:```bashyarn start```+Note that if you restart your computer, you’ll have to run this command again to start the server.+## Accessing Actual-You should now be able to access [http://localhost:5006](http://localhost:5006) in your browser and you will see Actual.+You should now be able to visit Actual by going to [http://localhost:5006](http://localhost:5006) in your browser.-When first accessing Actual, you may be prompted to provide a URL for the server. In this case (when installing locally), you can input `http://localhost:5006` or click the “use this domain” button below the text field (which will do the same thing).+When first accessing Actual, you may be prompted to provide a URL for the server. For a local installation like this, you can click the “Use localhost:5006” button to use the same URL as the one you’re accessing Actual from.diff --git a/docs/Installing/PikaPods.md b/docs/Installing/PikaPods.mdnew file mode 100644index 0000000000..12954930c6--- /dev/null+++ b/docs/Installing/PikaPods.md@@ -0,0 +1,14 @@+---+title: 'PikaPods'+---++## Deploying Actual on PikaPods++[PikaPods](https://www.pikapods.com/) offers one click "instant open source app hosting", allowing+you to run Actual for a little more than $1 per month (price may have changed since this document was updated).++## Deploying++[Click here to create an account and run Actual on PikaPods](https://www.pikapods.com/pods?run=actual). You can leave the resources at their lowest setting (although you will need a non-zero amount of storage for your budget files).++_Actual does almost all of its computation in your browser, so purchasing more resources for the server won’t necessarily result in a better experience_diff --git a/docs/Installing/Pikapods.md b/docs/Installing/Pikapods.mddeleted file mode 100644index a416ecb369..0000000000--- a/docs/Installing/Pikapods.md+++ /dev/null@@ -1,12 +0,0 @@-----title: 'PikaPods'------## Deploying Actual on Pikapods--[Pikapods](https://www.pikapods.com/) offers one click "instant open source app hosting", allowing-you to run the finest Open Source web apps from just $1/month.--## Deploying--[Click here to run Actual on PikaPods](https://www.pikapods.com/pods?run=actual)diff --git a/docs/Installing/fly/Fly-image.md b/docs/Installing/fly/Fly-image.mdindex be8006d7d7..2bd8b081c4 100644--- a/docs/Installing/fly/Fly-image.md+++ b/docs/Installing/fly/Fly-image.md@@ -2,8 +2,6 @@title: 'Deploying Actual with a container image'----[discord]: https://discord.gg/8JfAXSgfRf-# Deploying Actual on fly.io with a container image## Deploying@@ -124,8 +122,7 @@ variable.***A.** While we wouldn’t know for certain without seeing your configuration, it is likely that duringdeployment you created a Postgres database. Actual doesn’t need this so you can just delete it and- charges should then stop. If you're unsure, the [community in Discord][discord]- may be able to assist you.+ charges should then stop. If you're unsure, please [reach out to us](/Contact).## Official Imagesdiff --git a/docs/Installing/fly/Fly.io.md b/docs/Installing/fly/Fly.io.mdindex fca997f926..c5108bef4f 100644--- a/docs/Installing/fly/Fly.io.md+++ b/docs/Installing/fly/Fly.io.md@@ -2,7 +2,6 @@[image-guide]: ./Fly-image[terraform-guide]: ./Fly-terraform[ci-build]: https://github.com/actualbudget/actual-server/blob/master/.github/workflows/build.yml-[discord]: https://discord.gg/8JfAXSgfRf# Hosting Actual with [fly.io](https://fly.io)@@ -11,7 +10,7 @@ You should deploy your server so it's always running. [Fly.io](https://fly.io) poption with a free plan.See the next section for a brief comparison of fly.io deployment options. If you're stuck or find a-step unclear, the [community in Discord][discord] may be able to assist you.+step unclear, [contact us](/Contact) for support.## Deployment methods@@ -52,5 +51,4 @@ timing, you'll need a new image.**A.** While we wouldn’t know for certain without seeing your configuration, it is likely that duringdeployment you created a Postgres database. Actual doesn’t need this so you can just delete it and- charges should then stop. If you're unsure, the [community in Discord][discord]- may be able to assist you.+ charges should then stop. If you're unsure, please [reach out to us](/Contact).diff --git a/docs/Installing/overview.md b/docs/Installing/overview.mdindex 994848812f..d0c40b58b3 100644--- a/docs/Installing/overview.md+++ b/docs/Installing/overview.md@@ -1,28 +1,16 @@----title: 'Overview'+title: 'Installing Actual'----Installing Actual be it on your own personal computer or in the cloud is really simple, we have a selection of guides available that will help you get setup, but first, there are some things your going to need and also some things we need to tell you that we currently don't support.+Unlike most web apps, you’ll need to install Actual on a computer to get the full benefit out of it. While you could use Actual without running a server, we strongly recommend a server to ensure that your budget is saved and can be synced across multiple browsers and devices.-There are two basic methods of installing Actual. The first is to build from source. If you plan to build from source, package your own Docker images, or use Fly.io as your hosting provider there are a few pre-requisites to get started.+While running a server can be a complicated endeavor, we’ve tried to make it fairly easy to set up and hands-off to maintain. Choose one of the following options to get started:-If you would simply like to use the Docker images provided by the Actual development team, you only need to install Docker to run it locally. If you plan to use a hosting provider in the cloud like PikaPods, you may not have to install anything.--Pick one of our guides which should help you install Actual and identify the specific pre-requisites for an environment that is suitable for you.--### Pre-requisites from source code or Fly.io--We support all Operating systems including Windows, OSX or Linux.--Install [Git](https://git-scm.com/) for your operating system,--Install [NodeJS](https://nodejs.org/en/) version 14 or greater (version 19 is currently not supported),--You will need access to the internet.--Install [Yarn](https://yarnpkg.com/) using NPM, if you only just installed NodeJS you may need to restart your terminal.--```js-npm install --global yarn-```+- If you’re not comfortable with the command line and are willing to pay a small amount of money to have your version of Actual hosted on the cloud for you, we recommend [PikaPods](PikaPods.md).+- If you’re willing to run a few commands in the terminal:+ - [Fly.io](fly/Fly.io.md) offers free cloud hosting. (Make sure you read the section about [persisting your data](fly/Fly-persisting.md)!)+ - You could [directly install Actual locally](Local/your-own-machine.md) on macOS, Windows, or Linux if you don’t want to use a tool like Docker. (This method is the best option if you want to contribute to Actual!)+ - If you want to use Docker, we have instructions for [running Actual directly](Docker.md) inside Docker or [behind an nginx proxy that offers HTTPS support](DockerWithNginx.md).+- If you have a home server or a NAS running [Unraid](Unraid.md) or [Synology](synology/synology.md), we have instructions for installing Actual on those platforms.+If you have any other ways Actual can be hosted, please consider opening a pull request to add them to the documentation so that others can benefit from your experience.diff --git a/docs/Release-Notes/Release-Notes.md b/docs/Release-Notes.mdsimilarity index 99%rename from docs/Release-Notes/Release-Notes.mdrename to docs/Release-Notes.mdindex 99f74edea9..427480d85b 100644--- a/docs/Release-Notes/Release-Notes.md+++ b/docs/Release-Notes.md@@ -1,5 +1,5 @@----title: Releases Notes+title: Release Notes---## 23.1.12diff --git a/docs/index.md b/docs/index.mdindex 07a27aeca7..927ec2c048 100644--- a/docs/index.md+++ b/docs/index.md@@ -4,45 +4,10 @@ sidebar_position: 1title: 'Introduction'----### Add a bank account+Welcome to Actual’s documentation! Here you will find everything you need to know about Actual Budget (hopefully). If you see something missing, feel free to reach out to us (or, even better, click the “Edit this page” link at the bottom of any page to add any missing information yourself).-When first opening the app, it will ask you to add a bank account. You can find out how to do that [here](Accounts/addaccount)+## What should I read first?-### Set a budget+If you’re completely new to Actual, you’ll need to [install](/Installing/overview) it before you can use it. Once you’ve done that, check out the [Tour of Actual](/Getting-Started/using-actual) for a high-level overview of how Actual works. Then come back later to dive into the more detailed documentation in the “Using Actual” section.-Once onboarding is complete, you will see the budget page. Some basic categories are already for you, but you can add more by clicking the arrow on a category group.--Create your first budget by entering amounts into the "budgeted" column of the categories you want to track. Your starting balance will be available as money to budget (see [how budgeting works](/Budgeting/howitworks/)).--### Check back throughout the month--That's it! After you've made some more purchases, check back and [import your transactions](/Accounts/Transactions/importing-trans/). After categorizing them, you can see how your spending has impacted your budget.--Related reading: [importing transactions](/Accounts/Transactions/importing-trans/), [how budgeting works](/Budgeting/howitworks/), [managing categories](/Budgeting/categories/)--### Useful Links--Below is a list of useful links related to Actual Budget.--- [The open source announcement](https://actualbudget.com/open-source)-- [GitHub for Actual](https://github.com/actualbudget) - The source code for Actual, a local-first personal finance tool.-- [GitHub for Actual Server](https://github.com/actualbudget/actual-server) - The syncing server with web client included . All you need to run Actual.-- [GitHub repository of releases of Actual and Actual packages](https://github.com/actualbudget/releases)-- The official Docker image:-[https://hub.docker.com/r/jlongster/actual-server](https://hub.docker.com/r/jlongster/actual-server)--### Guides--- [Deploying Actual (youtube video)](https://www.youtube.com/watch?v=6ho_oA4MwXo) credit Marc Seitz-- [YNAB4 User Guide](https://hananhazime.files.wordpress.com/2015/12/ynab-print.pdf)--### Places to self host Actual--- [Fly.io](https://www.fly.io/)-- [PikaPods (one click)](https://www.pikapods.com/)-- [Unraid](https://unraid.net/)-- Docker--### Misc--- [James talking about Actual on the Change Log Podcast](https://changelog.com/podcast/495)+If you ever get stuck, don’t hesitate to [reach out to the maintainers and community](/Contact) for help.diff --git a/package.json b/package.jsonindex 0e1430d3fd..fd5202fe63 100644--- a/package.json+++ b/package.json@@ -16,6 +16,7 @@"dependencies": {"@cmfcmf/docusaurus-search-local": "^0.11.0","@docusaurus/core": "2.1.0",+ "@docusaurus/plugin-content-docs": "^2.3.0","@docusaurus/preset-classic": "2.1.0","@easyops-cn/docusaurus-search-local": "^0.33.5","@mdx-js/react": "^1.6.22",diff --git a/sidebars.js b/sidebars.jsindex 143e4a9803..774ffca808 100644--- a/sidebars.js+++ b/sidebars.js@@ -16,92 +16,105 @@ const unavailable = (title) => ({type: 'html',value: title,className: 'menu__link menu__link--unavailable',- defaultStyle: true-})+ defaultStyle: true,+});/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */const sidebars = {docs: ['index',+ 'Release-Notes',{type: 'category',- label: 'Installing Actual',- link: {- type: 'generated-index',- },+ label: 'Contributing',+ collapsed: true,items: [- 'Installing/overview',{- type: 'category',- label: 'On Your Own Machine',- items: [- 'Installing/Local/your-own-machine',- ]+ type: 'link',+ label: 'Issue Board',+ href: 'https://github.com/orgs/actualbudget/projects/1',},+ 'Developers/project-layout',+ 'Developers/preview-builds',+ 'Developers/releasing',+ 'Developers/Building-Windows',+ ],+ },+ {+ type: 'category',+ label: 'Getting Started',+ collapsible: false,+ items: [{type: 'category',- label: 'On Your Own Server',+ label: 'Installing Actual',link: {- type: 'generated-index',+ type: 'doc',+ id: 'Installing/overview',},items: [- 'Installing/Docker',- 'Installing/DockerWithNginx',- 'Installing/Unraid',{type: 'category',- label: 'Synology',- link: {- type: 'doc',- id: 'Installing/synology/synology',- },+ label: 'On Your Own Machine',+ collapsible: false,+ items: ['Installing/Local/your-own-machine'],+ },+ {+ type: 'category',+ label: 'On Your Own Server',+ collapsible: false,items: [- 'Installing/synology/synology-reverse-proxy',- 'Installing/synology/synology-watchtower',- ]+ 'Installing/Docker',+ 'Installing/DockerWithNginx',+ 'Installing/Unraid',+ {+ type: 'category',+ label: 'Synology',+ link: {+ type: 'doc',+ id: 'Installing/synology/synology',+ },+ items: [+ 'Installing/synology/synology-reverse-proxy',+ 'Installing/synology/synology-watchtower',+ ],+ },+ ],},- ]- },- {- type: 'category',- label: 'In the Cloud',- link: {- type: 'generated-index',- },- items: [{type: 'category',- label: 'Fly.io',- link: {- type: 'doc',- id: 'Installing/fly/Fly.io',- },+ label: 'In the Cloud',+ collapsible: false,items: [- 'Installing/fly/Fly-prerequisites',- 'Installing/fly/Fly-git',- 'Installing/fly/Fly-image',- 'Installing/fly/Fly-terraform',- 'Installing/fly/Fly-updating',- 'Installing/fly/Fly-persisting',+ {+ type: 'category',+ label: 'Fly.io',+ link: {+ type: 'doc',+ id: 'Installing/fly/Fly.io',+ },+ items: [+ 'Installing/fly/Fly-prerequisites',+ 'Installing/fly/Fly-git',+ 'Installing/fly/Fly-image',+ 'Installing/fly/Fly-terraform',+ 'Installing/fly/Fly-updating',+ 'Installing/fly/Fly-persisting',+ ],+ },+ 'Installing/PikaPods',+ 'Installing/Terraform',],},- 'Installing/Pikapods',- 'Installing/Terraform',- ]+ ],},- ],- },- {- type: 'category',- label: 'Getting Started',- link: {- type: 'generated-index',- },- collapsed: true,- items: [{type: 'category',- label: 'Using Actual',+ label: 'A Tour of Actual',+ link: {+ type: 'doc',+ id: 'Getting-Started/using-actual/index',+ },items: ['Getting-Started/using-actual/files','Getting-Started/using-actual/overview',@@ -110,7 +123,7 @@ const sidebars = {'Getting-Started/using-actual/budget','Getting-Started/using-actual/schedules','Getting-Started/using-actual/settings',- ]+ ],},'Getting-Started/tipstricks','Getting-Started/sync',@@ -123,156 +136,139 @@ const sidebars = {id: 'Getting-Started/migration/migration-intro',},items: [+ 'Getting-Started/migration/simple-sync',{type: 'category',label: 'Migrating From Other Apps',+ collapsible: false,items: ['Getting-Started/migration/ynab4',- 'Getting-Started/migration/nynab'- ]+ 'Getting-Started/migration/nynab',+ ],},- 'Getting-Started/migration/simple-sync',- ]+ ],},],},{type: 'category',- label: 'Budgeting',- collapsed: true,+ label: 'Using Actual',+ collapsible: false,items: [- 'Budgeting/howitworks',- 'Budgeting/filters',- 'Budgeting/categories',{type: 'category',- label: 'Rules',+ label: 'Budgeting',collapsed: true,link: {type: 'doc',- id: 'Budgeting/rules/rules',+ id: 'Budgeting/howitworks',},items: [- 'Budgeting/rules/rules-custom',+ 'Budgeting/filters',+ 'Budgeting/categories',+ {+ type: 'category',+ label: 'Rules',+ collapsed: true,+ link: {+ type: 'doc',+ id: 'Budgeting/rules/rules',+ },+ items: ['Budgeting/rules/rules-custom'],+ },+ 'Budgeting/schedules',+ 'Budgeting/returnsandreimbursements',+ 'Budgeting/creditcards',+ 'Budgeting/jointaccounts',+ //unavailable('Returns and Reimbursements'),],},- 'Budgeting/schedules',- 'Budgeting/returnsandreimbursements',- 'Budgeting/creditcards',- 'Budgeting/jointaccounts',- //unavailable('Returns and Reimbursements'),- ],- },- {- type: 'category',- label: 'Accounts',- collapsed: true,- items: [- 'Accounts/overview',- 'Accounts/addaccount',- 'Accounts/reconcile',{type: 'category',- label: 'Transactions',+ label: 'Accounts',collapsed: true,items: [- 'Accounts/Transactions/importing-trans',- 'Accounts/Transactions/bulk-editing-transactions',+ 'Accounts/overview',+ 'Accounts/addaccount',+ 'Accounts/reconcile',+ {+ type: 'category',+ label: 'Transactions',+ collapsible: false,+ items: [+ 'Accounts/Transactions/importing-trans',+ 'Accounts/Transactions/bulk-editing-transactions',+ ],+ },+ unavailable('Connecting Your Bank'),+ 'Accounts/payees',+ 'Accounts/transfers',],},- unavailable('Connecting Your Bank'),- 'Accounts/payees',- 'Accounts/transfers',- ],- },- {- type: 'category',- label: 'Reports',- collapsed: true,- items: [- 'Reports/overview',- unavailable('Custom Reports'),- ],- },- {- type: 'category',- label: 'Backup & Restore',- link: {- type: 'generated-index',- },- collapsed: true,- items: [- 'Backup-Restore/Backups',- 'Backup-Restore/Restore',- ],- },- {- type: 'category',- label: 'Developers',- link: {- type: 'generated-index',- },- collapsed: true,- items: [{- type: 'link',- label: 'Issue Board',- href: 'https://github.com/orgs/actualbudget/projects/1',+ type: 'category',+ label: 'Reports',+ collapsed: true,+ items: ['Reports/overview', unavailable('Custom Reports')],+ },+ {+ type: 'category',+ label: 'Backup & Restore',+ collapsed: true,+ items: ['Backup-Restore/Backups', 'Backup-Restore/Restore'],+ },+ {+ type: 'category',+ label: 'API',+ link: { type: 'doc', id: 'Developers/using-the-API' },+ items: [+ 'Developers/API',+ {+ type: 'category',+ label: 'ActualQL',+ collapsed: true,+ link: {+ type: 'doc',+ id: 'Developers/ActualQL/Overview',+ },+ items: [+ 'Developers/ActualQL/Functions',+ 'Developers/ActualQL/Examples',+ ],+ },+ ],},- 'Developers/project-layout',- 'Developers/preview-builds',- 'Developers/releasing',- 'Developers/Building-Windows',- 'Developers/using-the-API',- 'Developers/API',{type: 'category',- label: 'ActualQL',+ label: 'Advanced',collapsed: true,+ link: {+ type: 'doc',+ id: 'Advanced/advanced-intro',+ },items: [- 'Developers/ActualQL/Overview',- 'Developers/ActualQL/Functions',- 'Developers/ActualQL/Examples',+ {+ type: 'category',+ label: 'Scripts',+ collapsible: false,+ items: ['Advanced/Scripts/modify-transfers'],+ },],},],},- 'FAQ',- {- type: 'category',- label: 'Troubleshooting',- link: {- type: 'generated-index',- },- collapsed: true,- items: [- 'Troubleshooting/Troubleshooting-Edge',- ],- },- {- type: 'category',- label: 'Release Notes',- collapsed: true,- items: [- 'Release-Notes/Release-Notes'- ],- },{type: 'category',- label: 'Advanced',- collapsed: true,- link: {- type: 'doc',- id: 'Advanced/advanced-intro',- },+ label: 'Help & Support',+ collapsible: false,items: [+ 'Contact',+ 'FAQ',{type: 'category',- label: 'Scripts',+ label: 'Troubleshooting',collapsed: true,- items: [- 'Advanced/Scripts/modify-transfers',- ],+ items: ['Troubleshooting/Troubleshooting-Edge'],},],},diff --git a/src/css/custom.css b/src/css/custom.cssindex dcd75d2ed6..42f1337d33 100644--- a/src/css/custom.css+++ b/src/css/custom.css@@ -34,3 +34,27 @@pointer-events: none;opacity: 0.5;}++.menu__list-item-collapsible > .menu__link:not([aria-expanded]) {+ pointer-events: none;+ user-select: none;+ text-transform: uppercase;+ font-size: 0.8em;+ padding-top: 16px;+ padding-bottom: 3px;+}+.theme-doc-sidebar-item-category-level-1+ > .menu__list-item-collapsible+ .menu__link:not([aria-expanded]) {+ padding-top: 22px;+ padding-bottom: 3px;+}++.menu__list-item-collapsible:has(> .menu__link:not([aria-expanded]))+ + .menu__list {+ padding-left: 0;+}++.menu__list-item-collapsible:has(.menu__link:not([aria-expanded])) {+ pointer-events: none;+}