Commit Graph

71 Commits

Author SHA1 Message Date
Ruben Olsen Lærk
76c0e615af Added information on how to manage spelling errors in the docs (#760)
People are unsure on how to handle the spelling bot errors.
2025-07-31 08:35:39 +02:00
Ruben Olsen Lærk
e75e9b95aa Added Warning callout as this was missing (#737)
We use warnings several places, especially with regards to experimental
features.
2025-06-30 15:35:11 +02:00
Matiss Janis Aboltins
a00b584126 Add Cursor IDE documentation (#730)
- 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.
2025-06-25 20:55:40 +01:00
Matiss Janis Aboltins
ad88007829 Document payment system for core contributors and update proposal status (#723) 2025-06-23 18:42:11 +01:00
Spencer-Sawyer
4f9e4581f3 Update contributing/project-details (#714)
- Desktop electron works with self hosted out of the box now.
- Made Sync Server a third level header for consistency since it's no
longer in a separate repo.
2025-06-14 07:55:16 -04:00
Michael Clark
456ffa6f5b Update core team (#722)
Teprifer joined Alumni on 2025-05-10 


https://discord.com/channels/937901803608096828/1106842738239995904/1370882805587775640
2025-06-12 21:21:48 +01:00
Matiss Janis Aboltins
70468a8a64 📝 (proposal for spending community funds) (#709)
Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2025-06-08 16:01:33 +01:00
Matiss Janis Aboltins
8699fc2865 Add sponsored Cursor subscription details for core contributors (#721) 2025-06-07 13:46:20 +01:00
Matiss Janis Aboltins
c441df5377 Add triaging issues guidelines to contributing documentation (#720) 2025-06-07 13:45:20 +01:00
Julian Dominguez-Schatz
d0fc4949be Update release docs with the latest changes (#705) 2025-05-23 19:07:18 -04:00
Matt Fiddaman
4e243420fa change minimum version of Node.js to version 20 (#692)
I think I got all instances where we specify a version, there seem to
only be two places in the docs.

We'll also call it out in the release notes.

https://github.com/actualbudget/actual/pull/4978
2025-05-12 19:17:10 +02:00
Michael Clark
0bc8db4ed5 Docs for new sync-server npm package (#680)
**To be merged on the next release.**

Goes with the new @actual-app/sync-server package:
https://github.com/actualbudget/actual/pull/4798

**Pages changed:**
- https://deploy-preview-680.www.actualbudget.org/docs/install/
- https://deploy-preview-680.www.actualbudget.org/docs/install/cli-tool
-
https://deploy-preview-680.www.actualbudget.org/docs/contributing/releasing
- https://deploy-preview-680.www.actualbudget.org/docs/config

**Notable changes**
- New CLI Tool docs
- Cutting a release - we no longer need to manually publish any npm
packages.

---------

Co-authored-by: Julian Dominguez-Schatz <julian.dominguezschatz@gmail.com>
2025-05-03 13:56:44 -04:00
Matiss Janis Aboltins
9cbcc035ac Update index.md (#686) 2025-04-23 18:52:38 +01:00
Alec Bakholdin
a30b406781 Update documentation to include new yarn generate:release-notes script (#665)
Referenced script is introduced here
https://github.com/actualbudget/actual/pull/4664
2025-03-26 00:05:12 -04:00
Michael Clark
d5b6e40c81 Update docs with new instructions for workspace reference in server (#661)
Should be merged with: https://github.com/actualbudget/actual/pull/4569

**Changed pages:** 
- https://deploy-preview-661.www.actualbudget.org/docs/install/local
-
https://deploy-preview-661.www.actualbudget.org/docs/contributing/project-details/
-
https://deploy-preview-661.www.actualbudget.org/docs/contributing/releasing/
-
https://deploy-preview-661.www.actualbudget.org/docs/contributing/windows/
-
https://deploy-preview-661.www.actualbudget.org/docs/actual-server-repo-move/
2025-03-14 09:08:50 +00:00
Matt Fiddaman
531cdc264a add lelemm to maintainer list (#649) 2025-02-26 17:23:13 +00:00
Michael Clark
ba49c1651e Upating Local install docs for people on a clean clone (#645)
Issue reported here: https://github.com/actualbudget/actual/issues/4377

https://deploy-preview-645.www.actualbudget.org/docs/install/local

It turns out that yarn doesn't let you run scripts without first
installing dependencies, so users will have to type it in the install
manually.

The other alternative is to run the script with npm but that would add
confusion.

I think yarn workspace focus is the best option to pick but here was the
options:

- Instruct users to ```yarn install``` (which would install all deps) -
1.07GB
- Instruct users to ```yarn workspaces focus @actual-app/sync-server
--production``` (which is a long command) - 60.6MB
- Create a new shell script to run the command ```
./install-server.sh```

In future we might want to consider packaging the server up into an
executable. That way the user wont have to install node/deal with any of
this stuff.

Here's an example packager - i've never used it:
https://github.com/nexe/nexe
2025-02-17 09:15:36 +00:00
Michael Clark
a0a0d5de51 Updating references to Actual-Server to point to Actual repository (#620) 2025-02-10 22:29:03 +00:00
Julian Dominguez-Schatz
b5b3b533bf Add docs about releasing translations (#627) 2025-02-05 16:19:54 -05:00
Julian Dominguez-Schatz
4fd70cab8f Update translation docs (#610) 2025-01-11 15:28:39 -05:00
Ruben Olsen Lærk
2fa1d34d17 #470 - added section on Pay Yourself First strategy (#473)
A go at #470
2025-01-08 19:53:20 +01:00
Julian Dominguez-Schatz
7666337df6 Update releasing.md for release notes (#605)
Goes with https://github.com/actualbudget/actual/pull/4105
2025-01-07 18:36:00 -05:00
Matiss Janis Aboltins
17057027d5 📝 add UnderKoen and RubenOlsen to maintainer list (#595) 2025-01-04 13:55:17 +00:00
Matt Fiddaman
9fccd1e6dd Improve release documentation for maintainers (#580) 2024-12-16 17:17:42 +00:00
bpaulien
553d18e938 Update index.md (#569)
title case, punctuation
2024-12-11 23:55:19 +00:00
bpaulien
af720eecac Update index.md (#570)
punctuation, grammar, clarified name of nYNAB
2024-12-11 23:55:12 +00:00
bpaulien
d23eb40401 Update migrations.md (#573)
punctuation
2024-12-11 23:54:56 +00:00
bpaulien
b590d68a92 Update new-core-contributors-guide.md (#579)
punctuation, title case
2024-12-11 23:54:37 +00:00
bpaulien
dbca4c9962 Update writing-docs.md (#578)
punctuation, title case,
2024-12-11 23:54:30 +00:00
bpaulien
020f9c7dc0 Update releasing.md (#576)
punctuation, title case
2024-12-11 23:54:22 +00:00
bpaulien
11c2ec4255 Update preview-builds.md (#575)
capitalization, wording, remove duplicated paragraph
2024-12-11 23:54:16 +00:00
bpaulien
3687e7ae09 Update i18n.md (#574)
title case
2024-12-11 23:54:09 +00:00
bpaulien
eafd128c63 Update feature-flags.md (#572)
title case, punctuation, added clarifying words
2024-12-11 23:54:01 +00:00
bpaulien
51bbdcf1c4 Update database.md (#571)
punctuation, phrasing for better understanding
2024-12-11 23:53:54 +00:00
bpaulien
a66540d2b2 Update windows.md (#577)
punctuation, title case
2024-12-11 23:52:44 +00:00
Matt Fiddaman
842bc40d0c fix some spelling issues, standardis(z)e to US English (#521)
Quick whip through to try and standardis(z)e some language, looks like
the most common English in the docs is US English so I chose that one,
but if we'd prefer the Queen's then that's okay too.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-11-29 06:45:45 +01:00
Matt Fiddaman
1faead2732 whitespace fixes (#522)
Removes double spacing and trailing whitespace.
2024-11-28 21:40:12 +01:00
bpaulien
903612c905 [WIP] Update writing-docs.md (#498)
Removed redundant word.
2024-11-26 14:51:32 +00:00
Jonathan Fang
4044a14da2 Add info on how to access edge build via edge.actualbudget (#471)
add mention of how to access the edge build of actual, i couldn't find
it anywhere else in the documentation.

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
2024-10-17 23:55:43 +02:00
Matiss Janis Aboltins
d27a135613 📝 update "how to cut a release" doc (#461) 2024-10-04 08:12:37 +01:00
Muhammad Talal Anwar
826c1095e6 [WIP] docs: fix typos (#455) 2024-09-22 20:19:30 +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
Michael Clark
96f480ef3c Adding instructions for the windows store release (#436)
![image](https://github.com/user-attachments/assets/c3c561d7-b0ee-4ea6-81ee-d19d664099ca)
2024-08-17 13:27:09 +01:00
Julian Wachholz
583dd24423 Remove namespace from i18n example (#434)
Actual Budget does not use namespaces in the translations.
Also adds additional section about handling interpolation using the
<Trans> component.
2024-08-16 16:44:04 +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
Matiss Janis Aboltins
48c9efb354 📝 update the API docs information (#414)
Removing some outdated information. The API package has been available
for a while already.
2024-07-26 21:08:49 +01:00
Matiss Janis Aboltins
30a47b48df 📝 update core contributor list (#410) 2024-07-21 18:38:31 +01:00
Matiss Janis Aboltins
56abc1c3f3 📝 update core contributor list (#372) 2024-06-23 07:06:19 +01:00
Matiss Janis Aboltins
dfbcfc25db 📝 update release instructions (#368) 2024-06-07 21:43:41 +01:00
Matiss Janis Aboltins
fbdd357de4 📝 update core contributor list (#361) 2024-06-03 19:28:47 +01:00