Commit Graph

760 Commits

Author SHA1 Message Date
Matt Fiddaman
dab3ffc762 Moved docs into packages/docs directory 2025-11-07 18:17:14 +00:00
Juulz
dbfb4e5206 Update Credit Card Section Fixes #742 (#814)
I am unable to upload images from my fork. They are here:

[images](https://github.com/Juulz/docs/tree/master/static/img/credit-cards)

Updated Credit Cards:

- Rewrote index.md to explain how Actual treats credit cards
- Split off Paying in Full - Within the Budget and rewrote with
screenies
- Rewrote Carrying debt with screenies 

Please add Citi and Citibank to allowed words. Thank you.

---------

Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-11-07 08:34:10 -07:00
scojo
44768370e0 Add documentation page for Crossover Point Report experimental feature (#817)
The feature is proposed in PR
[5554](https://github.com/actualbudget/actual/pull/5554)
2025-11-07 08:33:42 -07:00
rodriguestiago0
c600bde17a [WIP] Update community docs (#824) 2025-11-06 18:02:27 -07:00
Adam Millerchip
979171a591 Update roadmap-for-new-users.md (#823)
The current roadmap only contained a subset of the options for setting
up a server. Rather than maintain two copies of the same information (or
preferring one method over the other), I think it's best to simply link
to the relevant section.
2025-11-06 08:41:42 -07:00
Michael Clark
f0b3884b4b Create org.flathub.VerifiedApps.txt for flathub verification (#825)
Adds flathub verification file so we can prove the domain belongs to us.


https://deploy-preview-825.www.actualbudget.org/.well-known/org.flathub.VerifiedApps.txt

When merged it will be:
https://actualbudget.com/.well-known/org.flathub.VerifiedApps.txt
2025-11-05 21:50:14 +00:00
Julian Dominguez-Schatz
9e1edfb7df 🔖 (25.11.0) (#822)
https://github.com/actualbudget/actual/pull/6059
2025-11-03 19:28:19 -05:00
racehd
c95a4bfc78 link simplefin docs in bank-sync.md (#818)
GoCardless is linked but SimpleFin is not. Improves navigation
2025-11-03 04:43:06 +00:00
frank_zhang
dd66a24103 Update budget.md (#775)
Corrected functions in specific month's budget categories.
2025-11-03 04:42:15 +00:00
Stephen Brown II
8ce7420199 Update auto_stop_machines setting in fly.md (#819)
- Updated auto_stop_machines setting to 'stop' to match fly.io
documentation.
- Added min_machines_running setting, set to 0.

See https://fly.io/docs/reference/configuration/#the-services-sections
2025-11-03 04:40:37 +00:00
Matiss Janis Aboltins
6c58e77ebb Add faq about budget file size shrinking (#816) 2025-10-22 22:51:07 +02:00
Jessica L
d712891921 Update nynab.md (#815)
Added instructions for using jq to pretty print budget list and find
budget id

---------

Co-authored-by: Stephen Brown II <Stephen.Brown2@gmail.com>
2025-10-22 19:11:43 +01:00
Matt Fiddaman
07224b1dfd drop support for node 20 (#811)
Supplements https://github.com/actualbudget/actual/pull/5937
2025-10-22 17:17:08 +01:00
Stephen Brown II
9bb5c18ef5 Add balance to rule template docs (#813)
Relates to https://github.com/actualbudget/actual/pull/5925

Documentation improvements:

* Added `balance` as a supported template variable, describing its type
and value in the template variables table.
* Updated spacing to fix some markdown lints.
2025-10-18 08:23:33 -07:00
Andrew
0e09aec9fd Remove condition regarding split transactions (#812)
---
category: Enhancements
authors: [AndrewG147]
---

Transfers can now be created from split transactions (changed in
[25.9.0](https://github.com/actualbudget/actual/pull/5604)). The former
condition is not valid anymore
2025-10-18 07:48:40 -07:00
Karim Kodera
117b77d6d7 Documentation for Schedule API based on CRUD. (#729) 2025-10-10 22:55:38 +01:00
Matiss Janis Aboltins
9087add617 Blog post: continuing contributor payments (#808) 2025-10-06 18:58:32 +01:00
Matiss Janis Aboltins
f607f3dd79 Update Yarn configuration and dependencies; migrate to Yarn 4.10.3 (#809) 2025-10-04 10:27:42 +01:00
Matt Fiddaman
a60cef1f3f 🔖 (25.10.0) (#806)
Actual: https://github.com/actualbudget/actual/pull/5834
Docs: https://github.com/actualbudget/docs/pull/806

---------

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
2025-10-02 12:30:30 +01:00
Dustin
2f260699ee Update text widget description in index.md (#807)
Updated text widget description since it does not actually run or
generate a report.
2025-10-02 01:00:27 +01:00
Jonas
aebaf42eed rule-templating: clarify meaning of sub prefix in date functions (#803) 2025-09-28 00:09:15 +01:00
Eric J
f0fcdf41e4 Update Tips and Tricks (#805)
Added section highlighting the ability to use math operators in amounts
2025-09-25 14:43:24 +01:00
Martyn Ranyard
c19cd3ce57 Added more notice that GoCardless no longer accepts new accounts. (#799)
Users will attempt to install actual, and connect it, but then find they
cannot sign up, so pointing this out earlier is a good thing.

Ideally in the docs page actual should stop advertising it at all, and
simply leave the instructions there for people who already have
accounts, but not mention it in the features and such.
2025-09-23 13:58:46 +01:00
Matt Fiddaman
9a7df9b05d document api quiet mode (#802)
For https://github.com/actualbudget/actual/pull/5762
2025-09-22 13:01:32 +01:00
Ruben Olsen Lærk
ea349af32f Closing 787 by clarifying example image. (#790)
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2025-09-22 10:18:38 +01:00
Haritha Hasathcharu
e6ffa63aaa Fix minor spelling error (#801)
Fix a minor spelling error in `docs/advanced/restart.md`.
2025-09-21 10:16:30 -07:00
Amr Awad
58dcc66e50 [WIP] Add Lunch Flow to community projects (#800) 2025-09-20 21:58:09 +01:00
Matt Fiddaman
23a943a05b remove BANKS_WITH_LIMITED_HISTORY override instructions (#798)
https://github.com/actualbudget/actual/pull/5714
2025-09-11 15:48:28 +01:00
Matt Fiddaman
f1a8522b79 add warning for GoCardless sign up instructions (#797) 2025-09-11 15:48:14 +01:00
Abraham
277967c722 Fixing typo in documentation (#796) 2025-09-11 15:39:12 +01:00
Julian Dominguez-Schatz
afc97220b9 🔖 (25.9.0) (#794)
https://github.com/actualbudget/actual/pull/5663
2025-09-03 21:08:50 -04:00
Matiss Janis Aboltins
902f57a4a4 Fix contributor list by moving @alecbakholdin (#795) 2025-09-03 23:00:14 +01:00
Jonathan
fb5c47d13d Make Experimental Features installation instructions more obvious (#792)
I could not find instructions on the [Budget
Templates](https://actualbudget.org/docs/experimental/goal-templates)
experimental feature docs page for how to enable the feature. I did not
look closely enough at the advanced settings to realize I had to click a
link, even though I had looked at the setting page.

After asking in discord, I was told how to enable the feature, and even
found that there was a parent page [Experimental
Features](https://actualbudget.org/docs/experimental/) which had the
instructions I would have needed.

This PR simply adds a short sentence with a link back to that root page
on the experimental features pages. This would have helped me find my
own solution without needing to ask.

I did not add anything to the [Pluggy.ai
Setup](https://actualbudget.org/docs/experimental/pluggyai) page because
it has the blurb `Pluggy integration is experimental at this point, so
before you can use it you need to enable it under Settings -> Advanced
Settings -> Experimental Features -> Pluggy.ai Bank Sync` in the page
and didn't have the same callout sections at the warning callout
sections as the other pages at the top.
2025-09-02 08:33:51 -07:00
frank_zhang
0b926b86b1 Update sync.md (#786)
Add the lacking double quote in the sub-title: What Does Resetting Sync"
Mean
2025-08-15 06:21:41 -07:00
frank_zhang
9397bdd733 Made some adjustments to make the doc more readable (#788) 2025-08-15 06:21:07 -07:00
frank_zhang
5919ad79a1 Update restore.md (#784)
Completed the beginning introduction of Restoring a Backup doc

**P.S. The first screenshot illustrating where to close the finance file
needs to be updated to comply with that in the current version.**
<img width="384" height="402" alt="截屏2025-08-15 09 48 32"
src="https://github.com/user-attachments/assets/c44012df-ecc3-4d76-8280-858001c68aa8"
/>
2025-08-14 19:00:40 -07:00
frank_zhang
4d02e1edd9 Update filters.md (#782)
Make descriptions match picture
2025-08-13 20:29:26 -07:00
frank_zhang
5f6f430aed Update index.md (#779)
Making the sentence more accurate and easy-to-read.
2025-08-13 20:27:29 -07:00
frank_zhang
52c9849aed Update schedules.md (#778)
corrected a grammatical error
2025-08-13 20:26:31 -07:00
Pheggas
ea2d334c40 [WIP] Better readability and fixes (#754)
I changed two docs pages - multi user and oauth (opeid provider).

There were some minor inconsistencies and errors. I also fixed the
redirect URI from `<domain>/path/openid/callback` to
`<domain>/openid/callback` as the first one was incorrect for my
keycloak instance.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-11 16:05:25 +02:00
Michael Clark
5e6efe0f45 Change search plugin to a more accurate one (#771)
The search tool we use has always been a bit clunky for me. There's no
keyboard shortcut support, it doesn't look great, doesn't support react
19, and I had to write a theme sync function for it to work properly
with Docusaurus V3.

The package I've upgraded here fixes all those issues. I've also updated
all the packages to the latest version, and aligned the node support
with the Actual repo.

**Old (very inaccurate search):**

<img width="885" height="573" alt="image"
src="https://github.com/user-attachments/assets/eae157de-8282-412f-b89c-618f3e3e99e5"
/>

**New:** 

<img width="676" height="605" alt="image"
src="https://github.com/user-attachments/assets/145db22f-8216-4e3f-9a98-a8bd469f1494"
/>

It also comes with a fancy new search page when you click _See all
results_
2025-08-10 19:56:26 +01:00
Ruben Olsen Lærk
8e193f4887 Download page is now centered. (#774)
Fixing an old annoyance :-)
2025-08-10 20:18:37 +02:00
Ruben Olsen Lærk
e5da8818d5 Fixing #745 - Limitations of privacy filter not disclosed in docs (#772)
- Amended main explanation in Tips And Tricks
- Linked to the caveats from the Tour dealing with the UI.
- Bonus: Fixed ALT TEXT on images.
2025-08-10 18:16:03 +02:00
Ruben Olsen Lærk
e8b6d9a7b0 Another starting fresh method (#761)
Based on a discussion in #general-chat about starting fresh from
https://discord.com/channels/937901803608096828/940290142579605514/1400170231556603954

Thanks to Magnus Burnsides for this kick in the butt :-D
2025-08-10 16:22:37 +02:00
Michael Clark
622d97c06f Upgrade docusaurus (#769)
> [!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
2025-08-09 14:52:21 +01:00
Alex Camilleri
43bc27e00f [WIP] Adding bank: fixed instructions order (#766)
I encountered this issue when I [created a
PR](https://github.com/actualbudget/actual/pull/5479) to add a new bank
to Actual.
The docs were instructing me to first create the PR and then generate
the docs.

At the same time, when I tried to open the PR, the default template
message was instructing me to generate the release notes *before*
opening the PR.

```
<!-- Thank you for submitting a pull request! Make sure to follow the instructions to write release notes for your PR — it should only take a minute or two: https://github.com/actualbudget/docs#writing-good-release-notes. Try running yarn generate:release-notes *before* pushing your PR for an interactive experience. -->
```

I am not sure who is telling the truth here, but given the emphasis that
the template put on *before* I am inferring that the docs had the wrong
order. If this is not the case, of course feel free to nuke this PR and
update the GitHub template instead.
2025-08-07 07:58:24 +02:00
fritz
6ae701b389 fix: mention ACTUAL_DATA_DIR is now dataDar in config (#758)
<!-- The process for Actual Budget Community Documentation pull requests
is documented at
https://actualbudget.org/docs/contributing/#submitting-a-pull-request
-->

Fixes
[actualbudget/actual/#5395](https://github.com/actualbudget/docs/issues/759)

**TL;DR** ACTUAL_DATA_DIR works as an env variable but not in the
config.json anymore. That comes up if you are migrating from the old
server to the new.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-06 21:48:12 +02:00
Matt Fiddaman
c8fb61e270 add paying contributors page to sidebar (#764)
I found this through the blog post, but the page wasn't set up correctly
with a title and didn't appear in the sidebar.

Before:
https://actualbudget.com/docs/contributing/leadership/paying-contributors

After:
https://deploy-preview-764.www.actualbudget.org/docs/contributing/leadership/paying-contributors

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-08-06 13:43:33 +02:00
POGMAN
cf1cafa46b Add Tags documentation (#756)
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>
2025-08-02 12:17:22 -04:00
Matt Fiddaman
f9a33a14d6 🔖 (25.8.0) (#763)
Actual PR: https://github.com/actualbudget/actual/pull/5447
2025-08-02 12:17:11 -04:00