Skip to content

Commit aa9d7aa

Browse files
committed
Merge
2 parents 2d560d9 + cac4be7 commit aa9d7aa

667 files changed

Lines changed: 43902 additions & 11505 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: 'Documentation'
2+
description: Report documentation issues, request new documentation, or suggest improvements to existing docs.
3+
title: '[DOCS] - <title>'
4+
labels: ['documentation']
5+
body:
6+
- type: dropdown
7+
id: issue-type
8+
attributes:
9+
label: 'Issue Type'
10+
description: What type of documentation issue is this?
11+
options:
12+
- New Documentation Request
13+
- Documentation Improvement
14+
- Documentation Bug/Error
15+
- Documentation Change Request
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: description
20+
attributes:
21+
label: 'Description'
22+
description: Please describe the documentation issue, request, or improvement
23+
placeholder: Provide a clear and detailed description...
24+
validations:
25+
required: true
26+
- type: input
27+
id: doc-url
28+
attributes:
29+
label: 'Documentation URL'
30+
description: If this relates to existing documentation, please provide the URL
31+
placeholder: ex. https://actualbudget.org/docs/budgeting/categories or https://github.com/actualbudget/actual/blob/master/packages/docs/...
32+
validations:
33+
required: false
34+
- type: dropdown
35+
id: category
36+
attributes:
37+
label: 'Documentation Category'
38+
description: What category does this relate to?
39+
multiple: true
40+
options:
41+
- Accounts
42+
- Backup & Restore
43+
- Budgeting
44+
- Development
45+
- Installation & Configuration
46+
- Overview
47+
- Reports
48+
- Troubleshooting
49+
- Other
50+
validations:
51+
required: false
52+
- type: textarea
53+
id: expected-behavior
54+
attributes:
55+
label: 'Expected/Desired Content'
56+
description: If applicable, describe what you expect to see or what should be documented
57+
placeholder: What should the documentation say or include?
58+
validations:
59+
required: false
60+
- type: textarea
61+
id: screenshot
62+
attributes:
63+
label: 'Screenshots or Examples'
64+
description: If applicable, add screenshots or examples to help explain your request
65+
value: |
66+
![DESCRIPTION](LINK.png)
67+
render: bash
68+
validations:
69+
required: false
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# check-spelling/check-spelling configuration
2+
3+
| File | Purpose | Format | Info |
4+
| -------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
5+
| [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) |
6+
| [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) |
7+
| [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) |
8+
| [excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) |
9+
| [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) |
10+
| [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) |
11+
| [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) |
12+
| [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) |
13+
| [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) |
14+
| [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) |
15+
16+
Note: you can replace any of these files with a directory by the same name (minus the suffix)
17+
and then include multiple files inside that directory (with that suffix) to merge multiple files together.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
2+
<details>
3+
<summary>If the flagged items are :exploding_head: false positives</summary>
4+
5+
If items relate to a ...
6+
7+
- binary file (or some other file you wouldn't want to check at all).
8+
9+
Please add a file path to the `excludes.txt` file matching the containing file.
10+
11+
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.
12+
13+
`^` 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).
14+
15+
- well-formed pattern.
16+
17+
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
18+
try adding it to the `patterns.txt` file.
19+
20+
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.
21+
22+
Note that patterns can't match multiline strings.
23+
24+
</details>
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
trevdor
2+
Farlow
3+
Matiss
4+
Aboltins
5+
jlongster
6+
howell
7+
evequefou
8+
Fiddaman
Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
ABANCA
2+
actualbudget
3+
addtransactions
4+
Akahu
5+
AMZN
6+
Andelskassen
7+
AQL
8+
Authelia
9+
autocompletes
10+
Blix
11+
bnp
12+
BSCHESMM
13+
BTC
14+
CAGLESMM
15+
Caju
16+
caniuse
17+
Cardless
18+
CAROOT
19+
categorygroup
20+
Cembra
21+
Certbot
22+
CLI
23+
clickable
24+
clsx
25+
codemirror
26+
Coinbase
27+
commandlet
28+
Coverflex
29+
Crd
30+
crdt
31+
creditcards
32+
crowdsourced
33+
debian
34+
dedupes
35+
deleteaccount
36+
DKB
37+
dmg
38+
easybank
39+
Edenred
40+
Coverfelx
41+
emojis
42+
emoji
43+
escodegen
44+
EUR
45+
expando
46+
Firefox
47+
flyctl
48+
Formik
49+
Fortuneo
50+
gebabebb
51+
GEBABEBB
52+
Greenshot
53+
HSA
54+
htpasswd
55+
IBANs
56+
iex
57+
importtransactions
58+
ING
59+
invokable
60+
iwr
61+
jointaccounts
62+
jwl
63+
KBC
64+
kcab
65+
keyout
66+
KREDBEBB
67+
Kroger
68+
kubectl
69+
kubernetes
70+
ldaplogin
71+
letsencrypt
72+
libofx
73+
linting
74+
Linuxes
75+
linuxsvg
76+
lleskassen
77+
lte
78+
mac
79+
macsvg
80+
Mariushosting
81+
minimalistic
82+
monkeypatch
83+
Monobank
84+
Morrisons
85+
NAIAGB
86+
NDEADKKK
87+
Netflix
88+
netlify
89+
Nordea
90+
NORDEA
91+
nordigen
92+
notlike
93+
NRNBGB
94+
nynab
95+
offbudget
96+
ofx
97+
OFX
98+
oneof
99+
payeerule
100+
pikaday
101+
pikapods
102+
playsinline
103+
portalization
104+
Postgresql
105+
protobuf
106+
publix
107+
QFX
108+
QIF
109+
Quicken
110+
returnsandreimbursements
111+
Rezip
112+
roadmap
113+
RUpdate
114+
sankey
115+
SANTANDER
116+
screenshots
117+
SEB
118+
subfolders
119+
subreaper
120+
subtransaction
121+
subtransactions
122+
Suisse
123+
Sztup
124+
tini
125+
traefik
126+
Trafico
127+
Trumf
128+
Upstash
129+
useb
130+
usernames
131+
valign
132+
Venmo
133+
Weblate
134+
winsvg
135+
WSL
136+
Xxxxx
137+
ynab
138+
Ynab
139+
YNAB
140+
ZKB
141+
Zsolt
142+
IDBy
143+
isapprox
144+
isbetween
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
2+
(?:^|/)(?i)COPYRIGHT
3+
(?:^|/)(?i)LICEN[CS]E
4+
(?:^|/)3rdparty/
5+
(?:^|/)go\.sum$
6+
(?:^|/)package(?:-lock|)\.json$
7+
(?:^|/)pyproject.toml
8+
(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$
9+
(?:^|/)vendor/
10+
ignore$
11+
\.a$
12+
\.ai$
13+
\.avi$
14+
\.bmp$
15+
\.bz2$
16+
\.class$
17+
\.coveragerc$
18+
\.crt$
19+
\.css$
20+
\.dll$
21+
\.docx?$
22+
\.drawio$
23+
\.DS_Store$
24+
\.eot$
25+
\.exe$
26+
\.gif$
27+
\.git-blame-ignore-revs$
28+
\.gitattributes$
29+
\.graffle$
30+
\.gz$
31+
\.icns$
32+
\.ico$
33+
\.jar$
34+
\.jks$
35+
\.jpe?g$
36+
\.key$
37+
\.lib$
38+
\.lock$
39+
\.map$
40+
\.min\..
41+
\.mod$
42+
\.mp[34]$
43+
\.o$
44+
\.ocf$
45+
\.otf$
46+
\.pdf$
47+
\.pem$
48+
\.png$
49+
\.psd$
50+
\.pyc$
51+
\.pylintrc$
52+
\.s$
53+
\.svgz?$
54+
\.tar$
55+
\.tiff?$
56+
\.ttf$
57+
\.wav$
58+
\.webm$
59+
\.webp$
60+
\.woff2?$
61+
\.xlsx?$
62+
\.zip$
63+
^\.github/actions/spelling/
64+
^\.github/ISSUE_TEMPLATE/
65+
^\Q.github/workflows/spelling.yml\E$
66+
^\.yarn/
67+
^\Qnode_modules/\E$
68+
^\Qsrc/\E$
69+
^\Qstatic/\E$
70+
^\Q.github/\E$
71+
(?:^|/)package(?:-lock|)\.json$
72+
(?:^|/)yarn\.lock$
73+
(?:^|/)(?i)docusaurus.config.js
74+
(?:^|/)(?i)README.md
75+
^\static/

0 commit comments

Comments
 (0)