Skip to content

A local-first personal finance app

Spellchecker CI (#228)

shall0passf0e67d71d454
diff --git a/.github/actions/spelling/README.md b/.github/actions/spelling/README.md
new file mode 100644
index 0000000000..1f699f3de3
--- /dev/null
+++ b/.github/actions/spelling/README.md
@@ -0,0 +1,17 @@
+# check-spelling/check-spelling configuration
+
+File | Purpose | Format | Info
+-|-|-|-
+[dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary)
+[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
+[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
+[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
+[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
+[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
+[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns)
+[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
+[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
+[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
+
+Note: you can replace any of these files with a directory by the same name (minus the suffix)
+and then include multiple files inside that directory (with that suffix) to merge multiple files together.
diff --git a/.github/actions/spelling/advice.md b/.github/actions/spelling/advice.md
new file mode 100644
index 0000000000..1004eeaa60
--- /dev/null
+++ b/.github/actions/spelling/advice.md
@@ -0,0 +1,25 @@
+<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
+<details><summary>If the flagged items are :exploding_head: false positives</summary>
+
+If items relate to a ...
+* binary file (or some other file you wouldn't want to check at all).
+
+ Please add a file path to the `excludes.txt` file matching the containing file.
+
+ File paths are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
+
+ `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
+../tree/HEAD/README.md) (on whichever branch you're using).
+
+* well-formed pattern.
+
+ If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
+ try adding it to the `patterns.txt` file.
+
+ Patterns are Perl 5 Regular Expressions - you can [test](
+https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
+
+ Note that patterns can't match multiline strings.
+
+</details>
diff --git a/.github/actions/spelling/allow/contributers.txt b/.github/actions/spelling/allow/contributers.txt
new file mode 100644
index 0000000000..9dd258d83c
--- /dev/null
+++ b/.github/actions/spelling/allow/contributers.txt
@@ -0,0 +1,8 @@
+trevdor
+Farlow
+Matiss
+Aboltins
+jlongster
+howell
+evequefou
+
diff --git a/.github/actions/spelling/allow/keywords.txt b/.github/actions/spelling/allow/keywords.txt
new file mode 100644
index 0000000000..ea06c8510c
--- /dev/null
+++ b/.github/actions/spelling/allow/keywords.txt
@@ -0,0 +1,74 @@
+actualbudget
+addtransactions
+AMZN
+Authelia
+autocompletes
+Blix
+caniuse
+categorygroup
+clsx
+codemirror
+commandlet
+Crd
+crdt
+creditcards
+debian
+dedupes
+deleteaccount
+escodegen
+expando
+Firefox
+flyctl
+Formik
+htpasswd
+IBANs
+iex
+importtransactions
+invokable
+iwr
+jointaccounts
+jwl
+kcab
+keyout
+Kroger
+ldaplogin
+libofx
+linting
+lte
+minimalistic
+monkeypatch
+Morrisons
+Netflix
+netlify
+nordigen
+nynab
+offbudget
+OFX
+payeerule
+pikaday
+playsinline
+portalization
+Postgresql
+protobuf
+publix
+QFX
+QIF
+returnsandreimbursements
+Rezip
+RUpdate
+screenshots
+subfolders
+subreaper
+subtransaction
+subtransactions
+tini
+Upstash
+useb
+usernames
+valign
+Venmo
+WSL
+Xxxxx
+ynab
+YNAB
+Ynab
diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt
new file mode 100644
index 0000000000..ed14516798
--- /dev/null
+++ b/.github/actions/spelling/excludes.txt
@@ -0,0 +1,75 @@
+# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
+(?:^|/)(?i)COPYRIGHT
+(?:^|/)(?i)LICEN[CS]E
+(?:^|/)3rdparty/
+(?:^|/)go\.sum$
+(?:^|/)package(?:-lock|)\.json$
+(?:^|/)pyproject.toml
+(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$
+(?:^|/)vendor/
+ignore$
+\.a$
+\.ai$
+\.avi$
+\.bmp$
+\.bz2$
+\.class$
+\.coveragerc$
+\.crt$
+\.css$
+\.dll$
+\.docx?$
+\.drawio$
+\.DS_Store$
+\.eot$
+\.exe$
+\.gif$
+\.git-blame-ignore-revs$
+\.gitattributes$
+\.graffle$
+\.gz$
+\.icns$
+\.ico$
+\.jar$
+\.jks$
+\.jpe?g$
+\.key$
+\.lib$
+\.lock$
+\.map$
+\.min\..
+\.mod$
+\.mp[34]$
+\.o$
+\.ocf$
+\.otf$
+\.pdf$
+\.pem$
+\.png$
+\.psd$
+\.pyc$
+\.pylintrc$
+\.s$
+\.svgz?$
+\.tar$
+\.tiff?$
+\.ttf$
+\.wav$
+\.webm$
+\.webp$
+\.woff2?$
+\.xlsx?$
+\.zip$
+^\.github/actions/spelling/
+^\.github/ISSUE_TEMPLATE/
+^\Q.github/workflows/spelling.yml\E$
+^\.yarn/
+^\Qnode_modules/\E$
+^\Qsrc/\E$
+^\Qstatic/\E$
+^\Q.github/\E$
+(?:^|/)package(?:-lock|)\.json$
+(?:^|/)yarn\.lock$
+(?:^|/)(?i)docusaurus.config.js
+(?:^|/)(?i)README.md
+^\static/
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/.github/actions/spelling/line_forbidden.patterns b/.github/actions/spelling/line_forbidden.patterns
new file mode 100644
index 0000000000..cd1799f26a
--- /dev/null
+++ b/.github/actions/spelling/line_forbidden.patterns
@@ -0,0 +1,62 @@
+# reject `m_data` as there's a certain OS which has evil defines that break things if it's used elsewhere
+# \bm_data\b
+
+# If you have a framework that uses `it()` for testing and `fit()` for debugging a specific test,
+# you might not want to check in code where you were debugging w/ `fit()`, in which case, you might want
+# to use this:
+#\bfit\(
+
+# s.b. GitHub
+#\bGithub\b
+
+# s.b. GitLab
+\bGitlab\b
+
+# s.b. JavaScript
+\bJavascript\b
+
+# s.b. Microsoft
+\bMicroSoft\b
+
+# s.b. another
+\ban[- ]other\b
+
+# s.b. greater than
+\bgreater then\b
+
+# s.b. into
+#\sin to\s
+
+# s.b. opt-in
+\sopt in\s
+
+# s.b. less than
+\bless then\b
+
+# s.b. otherwise
+\bother[- ]wise\b
+
+# s.b. nonexistent
+\bnon existing\b
+\b[Nn]o[nt][- ]existent\b
+
+# s.b. preexisting
+[Pp]re[- ]existing
+
+# s.b. preempt
+[Pp]re[- ]empt\b
+
+# s.b. preemptively
+[Pp]re[- ]emptively
+
+# s.b. reentrancy
+[Rr]e[- ]entrancy
+
+# s.b. reentrant
+[Rr]e[- ]entrant
+
+# s.b. workaround(s)
+\bwork[- ]arounds?\b
+
+# Reject duplicate words
+\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s
diff --git a/.github/actions/spelling/patterns.txt b/.github/actions/spelling/patterns.txt
new file mode 100644
index 0000000000..f0e8a65b90
--- /dev/null
+++ b/.github/actions/spelling/patterns.txt
@@ -0,0 +1,78 @@
+# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
+
+# Questionably acceptable forms of `in to`
+# Personally, I prefer `log into`, but people object
+# https://www.tprteaching.com/log-into-log-in-to-login/
+\b[Ll]og in to\b
+
+# acceptable duplicates
+# ls directory listings
+[-bcdlpsw](?:[-r][-w][-Ssx]){3}\s+\d+\s+\S+\s+\S+\s+\d+\s+
+# C types and repeated CSS values
+\s(center|div|inherit|long|LONG|none|normal|solid|thin|transparent|very)(?: \g{-1})+\s
+# go templates
+\s(\w+)\s+\g{-1}\s+\`(?:graphql|json|yaml):
+# javadoc / .net
+(?:[\\@](?:groupname|param)|(?:public|private)(?:\s+static|\s+readonly)*)\s+(\w+)\s+\g{-1}\s
+
+# Commit message -- Signed-off-by and friends
+^\s*(?:(?:Based-on-patch|Co-authored|Helped|Mentored|Reported|Reviewed|Signed-off)-by|Thanks-to): (?:[^<]*<[^>]*>|[^<]*)\s*$
+
+# Autogenerated revert commit message
+^This reverts commit [0-9a-f]{40}\.$
+
+# ignore long runs of a single character:
+\b([A-Za-z])\g{-1}{3,}\b
+
+# Automatically suggested patterns
+# hit-count: 1255 file-count: 51
+# https/http/file urls
+(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]
+
+# hit-count: 1174 file-count: 33
+# GitHub SHAs (markdown)
+(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
+
+# hit-count: 6 file-count: 4
+# version suffix <word>v#
+(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))
+
+# hit-count: 6 file-count: 2
+# URL escaped characters
+\%[0-9A-F][A-F]
+
+# hit-count: 5 file-count: 4
+# hex runs
+\b[0-9a-fA-F]{16,}\b
+
+# hit-count: 4 file-count: 2
+# uuid:
+\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b
+
+# hit-count: 3 file-count: 2
+# discord
+/discord(?:app\.com|\.gg)/(?:invite/)?[a-zA-Z0-9]{7,}
+
+# hit-count: 2 file-count: 2
+# Contributor
+\[[^\]]+\]\(https://github\.com/[^/\s"]+\)
+@[^$\W]*-?\w+
+
+# hit-count: 1 file-count: 1
+# While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there
+# YouTube url
+\b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]*
+
+# hit-count: 1 file-count: 1
+# Google Fonts
+\bfonts\.(?:googleapis|gstatic)\.com/[-/?=:;+&0-9a-zA-Z]*
+
+# hit-count: 1 file-count: 1
+# hex digits including css/html color classes:
+(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b
+
+# docusaurus image paths, URLs
+[-a-zA-Z0-9@:%_\+.~#?&//=]{2,256}\.[a-z]{2,4}\b(\/[-a-zA-Z0-9@:%_\+.~#?&//=]*)?
+
+# eliminate words like [`nvm`] or [`asdf`] or [heidiSQL] without backquotes
+\[.+?]
diff --git a/.github/actions/spelling/reject.txt b/.github/actions/spelling/reject.txt
new file mode 100644
index 0000000000..b5a6d36809
--- /dev/null
+++ b/.github/actions/spelling/reject.txt
@@ -0,0 +1,10 @@
+^attache$
+benefitting
+occurences?
+^dependan.*
+^oer$
+Sorce
+^[Ss]pae.*
+^untill$
+^untilling$
+^wether.*
diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml
new file mode 100644
index 0000000000..d0ce0a8e17
--- /dev/null
+++ b/.github/workflows/spelling.yml
@@ -0,0 +1,151 @@
+name: Check Spelling
+
+# Comment management is handled through a secondary job, for details see:
+# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions
+#
+# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment
+# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare)
+# it needs `contents: write` in order to add a comment.
+#
+# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment
+# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment)
+# it needs `pull-requests: write` in order to manipulate those comments.
+
+# Updating pull request branches is managed via comment handling.
+# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list
+#
+# These elements work together to make it happen:
+#
+# `on.issue_comment`
+# This event listens to comments by users asking to update the metadata.
+#
+# `jobs.update`
+# This job runs in response to an issue_comment and will push a new commit
+# to update the spelling metadata.
+#
+# `with.experimental_apply_changes_via_bot`
+# Tells the action to support and generate messages that enable it
+# to make a commit to update the spelling metadata.
+#
+# `with.ssh_key`
+# In order to trigger workflows when the commit is made, you can provide a
+# secret (typically, a write-enabled github deploy key).
+#
+# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key
+
+on:
+ push:
+ branches:
+ - "**"
+ tags-ignore:
+ - "**"
+ pull_request_target:
+ branches:
+ - "**"
+ tags-ignore:
+ - "**"
+ types:
+ - 'opened'
+ - 'reopened'
+ - 'synchronize'
+ issue_comment:
+ types:
+ - 'created'
+
+jobs:
+ spelling:
+ name: Check Spelling
+ permissions:
+ contents: read
+ pull-requests: read
+ actions: read
+ security-events: write
+ outputs:
+ followup: ${{ steps.spelling.outputs.followup }}
+ runs-on: ubuntu-latest
+ if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
+ concurrency:
+ group: spelling-${{ github.event.pull_request.number || github.ref }}
+ # note: If you use only_check_changed_files, you do not want cancel-in-progress
+ cancel-in-progress: true
+ steps:
+ - name: check-spelling
+ id: spelling
+ uses: check-spelling/check-spelling@main
+ with:
+ suppress_push_for_open_pull_request: 1
+ checkout: true
+ check_file_names: 1
+ spell_check_this: check-spelling/spell-check-this@prerelease
+ post_comment: 0
+ use_magic_file: 1
+ experimental_apply_changes_via_bot: 1
+ use_sarif: 1
+ extra_dictionary_limit: 10
+ extra_dictionaries:
+ cspell:cpp/src/cpp.txt
+ cspell:software-terms/src/software-terms.txt
+ cspell:python/src/python/python-lib.txt
+ cspell:php/php.txt
+ cspell:node/node.txt
+ cspell:npm/npm.txt
+ cspell:typescript/typescript.txt
+ cspell:filetypes/filetypes.txt
+ cspell:html/html.txt
+ cspell:aws/aws.txt
+
+ comment-push:
+ name: Report (Push)
+ # If your workflow isn't running on push, you can remove this job
+ runs-on: ubuntu-latest
+ needs: spelling
+ permissions:
+ contents: write
+ if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push'
+ steps:
+ - name: comment
+ uses: check-spelling/check-spelling@main
+ with:
+ checkout: true
+ spell_check_this: check-spelling/spell-check-this@prerelease
+ task: ${{ needs.spelling.outputs.followup }}
+
+ comment-pr:
+ name: Report (PR)
+ # If you workflow isn't running on pull_request*, you can remove this job
+ runs-on: ubuntu-latest
+ needs: spelling
+ permissions:
+ pull-requests: write
+ if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')
+ steps:
+ - name: comment
+ uses: check-spelling/check-spelling@main
+ with:
+ checkout: true
+ spell_check_this: check-spelling/spell-check-this@prerelease
+ task: ${{ needs.spelling.outputs.followup }}
+ experimental_apply_changes_via_bot: 1
+
+ update:
+ name: Update PR
+ permissions:
+ contents: write
+ pull-requests: write
+ actions: read
+ runs-on: ubuntu-latest
+ if: ${{
+ github.event_name == 'issue_comment' &&
+ github.event.issue.pull_request &&
+ contains(github.event.comment.body, '@check-spelling-bot apply')
+ }}
+ concurrency:
+ group: spelling-update-${{ github.event.issue.number }}
+ cancel-in-progress: false
+ steps:
+ - name: apply spelling updates
+ uses: check-spelling/check-spelling@main
+ with:
+ experimental_apply_changes_via_bot: 1
+ checkout: true
+ ssh_key: "${{ secrets.CHECK_SPELLING }}"
diff --git a/blog/2023-01-12-release-23.1.12.md b/blog/2023-01-12-release-23.1.12.md
index a4c433242f..3868ff47e5 100644
--- a/blog/2023-01-12-release-23.1.12.md
+++ b/blog/2023-01-12-release-23.1.12.md
@@ -9,7 +9,7 @@ hide_table_of_contents: false
The release has notable of improvements of:
-- Read-only responsive view, this replaces our mobile apps, it is notable that this is read only only at this stage.
+- Read-only responsive view, this replaces our mobile apps, it is notable that this is read-only at this stage.
- Improvements to the sidebar design
<!--truncate-->
diff --git a/blog/2023-03-09-release-23.3.0.md b/blog/2023-03-09-release-23.3.0.md
index c1088c6742..86c4635d23 100644
--- a/blog/2023-03-09-release-23.3.0.md
+++ b/blog/2023-03-09-release-23.3.0.md
@@ -10,7 +10,7 @@ hide_table_of_contents: false
The release has the following notable features:
- _Experimental_ support for automatically syncing transactions from European bank accounts using Nordigen.
-- Filters in the the transaction list can now be edited.
+- Filters in the transaction list can now be edited.
- When connecting to a server for the first time, you no longer need to enter the server URL.
- You’ll now be notified of future updates to Actual.
- Large imports will no longer break in Safari.
diff --git a/blog/2023-03-13-release-23.3.2.md b/blog/2023-03-13-release-23.3.2.md
index 93efd0c215..ac31f7fe8f 100644
--- a/blog/2023-03-13-release-23.3.2.md
+++ b/blog/2023-03-13-release-23.3.2.md
@@ -27,7 +27,7 @@ Version: 23.3.2
- [#745](https://github.com/actualbudget/actual/pull/745) (nordigen) fallback to array version of remittanceInformationUnstructured if necessary — thanks @Jackenmen
- [#247](https://github.com/actualbudget/actual/pull/247) Route aggregate queries in transaction grouped mode through the correct layer to remove deleted transactions — thanks @jlongster
- [#743](https://github.com/actualbudget/actual/pull/743) (nordigen) fallback to bookingDate if valueDate is not set — thanks @MatissJanis
-- [#742](https://github.com/actualbudget/actual/pull/742) (nordigen) check server status before linking accs — thanks @MatissJanis
+- [#742](https://github.com/actualbudget/actual/pull/742) (nordigen) check server status before linking accounts — thanks @MatissJanis
### Maintenance
diff --git a/blog/2023-07-04-release-23.7.0.md b/blog/2023-07-04-release-23.7.0.md
index df7df04eb4..3955ea9d4c 100644
--- a/blog/2023-07-04-release-23.7.0.md
+++ b/blog/2023-07-04-release-23.7.0.md
@@ -74,7 +74,7 @@ Version: 23.7.0
- [#1219](https://github.com/actualbudget/actual/pull/1219) Auto-close the local/nordigen picker modal after creating an account — thanks @j-f1
- [#1224](https://github.com/actualbudget/actual/pull/1224) Imports from YNAB4/nYNAB will now link transfer transactions correctly — thanks @j-f1
- [#1234](https://github.com/actualbudget/actual/pull/1234) Stop page from refreshing when undoing — thanks @j-f1
-- [#1242](https://github.com/actualbudget/actual/pull/1242) Fixed exporting data from Desktop (Electon) app. — thanks @Shazib
+- [#1242](https://github.com/actualbudget/actual/pull/1242) Fixed exporting data from Desktop (Electron) app. — thanks @Shazib
- [#1247](https://github.com/actualbudget/actual/pull/1247) Mobile: reduce the height of account cards — thanks @MatissJanis
- [#1250](https://github.com/actualbudget/actual/pull/1250) Fix `link schedule` option in transaction table — thanks @MatissJanis
- [#1252](https://github.com/actualbudget/actual/pull/1252) Fix toggling of balances in all-accounts view — thanks @MatissJanis
diff --git a/docs-sidebar.js b/docs-sidebar.js
index d29d6d1f35..3bf1a8b241 100644
--- a/docs-sidebar.js
+++ b/docs-sidebar.js
@@ -122,9 +122,9 @@ const sidebars = {
'tour/settings',
],
},
- 'getting-started/tipstricks',
+ 'getting-started/tips-tricks',
'getting-started/sync',
- 'getting-started/managefiles',
+ 'getting-started/manage-files',
{
type: 'category',
label: 'Migration',
@@ -174,9 +174,9 @@ const sidebars = {
items: ['budgeting/rules/custom'],
},
'budgeting/schedules',
- 'budgeting/returnsandreimbursements',
- 'budgeting/creditcards',
- 'budgeting/jointaccounts',
+ 'budgeting/returns-and-reimbursements',
+ 'budgeting/credit-cards',
+ 'budgeting/joint-accounts',
//unavailable('Returns and Reimbursements'),
],
},
diff --git a/docs/api/reference.md b/docs/api/reference.md
index 88311a7e6d..e2985ab09a 100644
--- a/docs/api/reference.md
+++ b/docs/api/reference.md
@@ -272,7 +272,7 @@ Close an account. `transferAccountId` and `transferCategoryId` are optional if t
If the account has a non-zero balance, you need to specify an account with `transferAccountId` to transfer the money into. If you are transferring from an on-budget account to an off-budget account, you can optionally specify a category with `transferCategoryId` to categorize the transfer transaction.
-Tranferring money to an off-budget account needs a category because money is taken out of the budget, so it needs to come from somewhere.
+Transferring money to an off-budget account needs a category because money is taken out of the budget, so it needs to come from somewhere.
If you want to simply delete an account, see [`deleteAccount`](#deleteaccount).
diff --git a/docs/backup-restore/backup.md b/docs/backup-restore/backup.md
index 9761d41a68..6bf579bcdf 100644
--- a/docs/backup-restore/backup.md
+++ b/docs/backup-restore/backup.md
@@ -20,7 +20,7 @@ You can export your data from Actual at any time. To do so,
## Manually creating a backup from the desktop app
-This will force a backup to be created right now. Do this if you are going to do something that you might want to revert later (and don't want to use [undo](../getting-started/tipstricks.md#undoredo)).
+This will force a backup to be created right now. Do this if you are going to do something that you might want to revert later (and don't want to use [undo](../getting-started/tips-tricks.md#undo-redo)).
- Select the **File > Load Backup…** menu item
- Click **Backup Now**
diff --git a/docs/backup-restore/restore.md b/docs/backup-restore/restore.md
index bcf7163b49..0d206a3839 100644
--- a/docs/backup-restore/restore.md
+++ b/docs/backup-restore/restore.md
@@ -37,7 +37,7 @@ It is possible that you may encounter an error during restoration that says:
This should only happen when you're upgrading from a Docker image with the `edge` tag to a stable release, such as `latest`. This should not happen in other instances. If you find yourself seeing this bug, please submit a bug report.
-**IMPORTANT NOTE**: You *MUST* download a backup of each of your budgets using the process outlined above **before** continuing. It's always good practice to backup your data before upgrading to a new verison.
+**IMPORTANT NOTE**: You *MUST* download a backup of each of your budgets using the process outlined above **before** continuing. It's always good practice to backup your data before upgrading to a new version.
The fix for this is to manually migrate the your sqlite database in the steps outlined below:
diff --git a/docs/budgeting/creditcards.md b/docs/budgeting/credit-cards.md
similarity index 100%
rename from docs/budgeting/creditcards.md
rename to docs/budgeting/credit-cards.md
diff --git a/docs/budgeting/jointaccounts.md b/docs/budgeting/joint-accounts.md
similarity index 100%
rename from docs/budgeting/jointaccounts.md
rename to docs/budgeting/joint-accounts.md
diff --git a/docs/budgeting/returnsandreimbursements.md b/docs/budgeting/returns-and-reimbursements.md
similarity index 100%
rename from docs/budgeting/returnsandreimbursements.md
rename to docs/budgeting/returns-and-reimbursements.md
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
index bd1d171fc7..e751cdf13e 100644
--- a/docs/contributing/index.md
+++ b/docs/contributing/index.md
@@ -19,7 +19,7 @@ Here are some initial guidelines for how contributions will be treated:
- Multiple maintainers are key to this being a healthy project. Currently a few people have maintainer rights (see list below). We are actively looking for more people to come on as maintainers. If nobody steps up, expect less activity on this project.
-- An open PR does not automatically deserve time for a full review and acceptance. It's up to the PR author to convince the maintainers that the change is good and worth reviewing. This involves a clear description for why the the change is being made, detailing the tradeoffs.
+- An open PR does not automatically deserve time for a full review and acceptance. It's up to the PR author to convince the maintainers that the change is good and worth reviewing. This involves a clear description for why the change is being made, detailing the tradeoffs.
- We especially welcome improvements in automation: creating github actions to automatically generate builds, making the release process easier, etc.
diff --git a/docs/contributing/project-details/architecture.md b/docs/contributing/project-details/architecture.md
index 27720e91f0..299d4c0194 100644
--- a/docs/contributing/project-details/architecture.md
+++ b/docs/contributing/project-details/architecture.md
@@ -10,7 +10,7 @@ The code which is used by this background server, as well as code which is share
### Electron Notes
-* Generally speaking, it is unlikely that features/fixes you contribute to actual will require electon-specific changes. If you think that is likely feel free to discuss on github or in the actual discord.
+* Generally speaking, it is unlikely that features/fixes you contribute to actual will require electron-specific changes. If you think that is likely feel free to discuss on github or in the actual discord.
* Details of the motivation behind the usage of WebSockets in the electron app can be found in the [Pull Request](https://github.com/actualbudget/actual/pull/1003) where the changes were made.
diff --git a/docs/contributing/windows.md b/docs/contributing/windows.md
index 5b0e0dddd4..81bb70afe4 100644
--- a/docs/contributing/windows.md
+++ b/docs/contributing/windows.md
@@ -6,7 +6,7 @@ Many of the build scripts are bash scripts and not natively invokable in Windows
2. Ensure you have activated [Developer Mode](https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development)
3. Install Node v16.x (latest version 17.x does not work due to issue with crypto package)
4. Clone this repo
-5. Using Git Bash (run as administrator), change to the the root of this repo
+5. Using Git Bash (run as administrator), change to the root of this repo
6. From inside the bash shell, run `yarn install`
7. From still inside the shell, run `yarn start:browser`
8. Open your browser to [http://localhost:3001](http://localhost:3001)
diff --git a/docs/experimental/goal-templates.md b/docs/experimental/goal-templates.md
index 88818ae9f1..7a77775194 100644
--- a/docs/experimental/goal-templates.md
+++ b/docs/experimental/goal-templates.md
@@ -4,7 +4,7 @@
This is an **experimental feature**. That means we’re still working on finishing it. There may be bugs, missing functionality or incomplete documentation, and we may decide to remove the feature in a future release. If you have any feedback, please [open an issue](https://github.com/actualbudget/actual/issues) or post a message in the Discord.
:::
:::warning
-All functionality described here may not be available in the the latest stable release. Use the `edge` images for the latest implementation.
+All functionality described here may not be available in the latest stable release. Use the `edge` images for the latest implementation.
:::
Create a template by adding a note to a category and adding a line that begins with `#template`.
diff --git a/docs/getting-started/managefiles.md b/docs/getting-started/manage-files.md
similarity index 100%
rename from docs/getting-started/managefiles.md
rename to docs/getting-started/manage-files.md
diff --git a/docs/getting-started/tipstricks.md b/docs/getting-started/tips-tricks.md
similarity index 97%
rename from docs/getting-started/tipstricks.md
rename to docs/getting-started/tips-tricks.md
index 2e20596ed8..b83447aa75 100644
--- a/docs/getting-started/tipstricks.md
+++ b/docs/getting-started/tips-tricks.md
@@ -3,7 +3,7 @@ sidebar_position: 1
title: 'Tips & Tricks'
---
-## Undo/redo
+## Undo/redo {#undo-redo}
If you ever make a mistake, pressing <Key mod="cmd" k="z" /> will undo, and pressing <Key mod="cmd shift" k="z" /> will redo. This is an undo system that you can rely on; any change can be undone and the UI will walk back in time.
@@ -33,7 +33,7 @@ BUT here is one that WILL work in the web app as well:
- <Key k="f" /> Show only selected transactions.
- <Key k="d" /> Delete selected transactions.
-- <Key k="a" /> Set account for selected transations.
+- <Key k="a" /> Set account for selected transactions.
- <Key k="p" /> set payee for selected transactions.
- <Key k="n" /> Set notes for selected transactions.
- <Key k="c" /> Set category for selected transactions.
diff --git a/docs/releases.md b/docs/releases.md
index f15358ad56..f226a57c16 100644
--- a/docs/releases.md
+++ b/docs/releases.md
@@ -105,7 +105,7 @@ Version: 23.7.0
- [#1219](https://github.com/actualbudget/actual/pull/1219) Auto-close the local/nordigen picker modal after creating an account — thanks @j-f1
- [#1224](https://github.com/actualbudget/actual/pull/1224) Imports from YNAB4/nYNAB will now link transfer transactions correctly — thanks @j-f1
- [#1234](https://github.com/actualbudget/actual/pull/1234) Stop page from refreshing when undoing — thanks @j-f1
-- [#1242](https://github.com/actualbudget/actual/pull/1242) Fixed exporting data from Desktop (Electon) app. — thanks @Shazib
+- [#1242](https://github.com/actualbudget/actual/pull/1242) Fixed exporting data from Desktop (Electron) app. — thanks @Shazib
- [#1247](https://github.com/actualbudget/actual/pull/1247) Mobile: reduce the height of account cards — thanks @MatissJanis
- [#1250](https://github.com/actualbudget/actual/pull/1250) Fix `link schedule` option in transaction table — thanks @MatissJanis
- [#1252](https://github.com/actualbudget/actual/pull/1252) Fix toggling of balances in all-accounts view — thanks @MatissJanis
@@ -580,7 +580,7 @@ Version: 23.3.2
- [#745](https://github.com/actualbudget/actual/pull/745) (nordigen) fallback to array version of remittanceInformationUnstructured if necessary — thanks @Jackenmen
- [#247](https://github.com/actualbudget/actual/pull/247) Route aggregate queries in transaction grouped mode through the correct layer to remove deleted transactions — thanks @jlongster
- [#743](https://github.com/actualbudget/actual/pull/743) (nordigen) fallback to bookingDate if valueDate is not set — thanks @MatissJanis
-- [#742](https://github.com/actualbudget/actual/pull/742) (nordigen) check server status before linking accs — thanks @MatissJanis
+- [#742](https://github.com/actualbudget/actual/pull/742) (nordigen) check server status before linking accounts — thanks @MatissJanis
#### Maintenance
@@ -625,7 +625,7 @@ Version: 23.3.1
The release has the following notable features:
- _Experimental_ support for automatically syncing transactions from European bank accounts using Nordigen.
-- Filters in the the transaction list can now be edited.
+- Filters in the transaction list can now be edited.
- When connecting to a server for the first time, you no longer need to enter the server URL.
- You’ll now be notified of future updates to Actual.
- Large imports will no longer break in Safari.
@@ -863,7 +863,7 @@ Version: 23.2.5
The release has notable of improvements of:
-- Read-only responsive view, this replaces our mobile apps, it is notable that this is read only only at this stage.
+- Read-only responsive view, this replaces our mobile apps, it is notable that this is read-only at this stage.
- Improvements to the sidebar design
### Actual
diff --git a/src/pages/index.js b/src/pages/index.js
index bdab340459..fc9ece1cfc 100644
--- a/src/pages/index.js
+++ b/src/pages/index.js
@@ -188,7 +188,7 @@ export default function Hello() {
<SmallFeature
title="Undo & redo"
icon={icons.rotateBack}
- learnMore="/docs/getting-started/tipstricks#undoredo"
+ learnMore="/docs/getting-started/tips-tricks#undo-redo"
>
A robust undo system allows you to rollback any changes you make,
and redo them if desired. Never worry about making mistakes.
diff --git a/static/_redirects b/static/_redirects
index 264ef51435..03b7cc8ba6 100644
--- a/static/_redirects
+++ b/static/_redirects
@@ -14,10 +14,10 @@
/blog/?filter=release /blog/tags/release
/docs/overview/getting-started /docs/tour/
-/docs/overview/tips-&-tricks /docs/getting-started/tipstricks/
+/docs/overview/tips-&-tricks /docs/getting-started/tips-tricks/
/docs/overview/syncing-across-devices /docs/getting-started/sync/
/docs/overview/migrating-from-other-apps /docs/migration/
-/docs/overview/managing-files /docs/getting-started/managefiles/
+/docs/overview/managing-files /docs/getting-started/manage-files/
/docs/overview/loading-a-backup /docs/backup-restore/restore/
/docs/accounts/overview/ /docs/accounts/
@@ -36,3 +36,8 @@
/docs/developers/using-the-API/ /docs/api/
/docs/developers/API/ /docs/api/reference/
/docs/developers/ActualQL/ /docs/api/actual-ql/
+
+#files were renamed as part of PR#228
+/docs/budgeting/returnsandreimbursements /docs/budgeting/returns-and-reimbursements
+/docs/budgeting/creditcards /docs/budgeting/credit-cards
+/docs/budgeting/jointaccounts /docs/budgeting/joint-accounts