diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000000..b91a6683dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,69 @@ +name: 'Documentation' +description: Report documentation issues, request new documentation, or suggest improvements to existing docs. +title: '[DOCS] - ' +labels: ['documentation'] +body: + - type: dropdown + id: issue-type + attributes: + label: 'Issue Type' + description: What type of documentation issue is this? + options: + - New Documentation Request + - Documentation Improvement + - Documentation Bug/Error + - Documentation Change Request + validations: + required: true + - type: textarea + id: description + attributes: + label: 'Description' + description: Please describe the documentation issue, request, or improvement + placeholder: Provide a clear and detailed description... + validations: + required: true + - type: input + id: doc-url + attributes: + label: 'Documentation URL' + description: If this relates to existing documentation, please provide the URL + placeholder: ex. https://actualbudget.org/docs/budgeting/categories or https://github.com/actualbudget/actual/blob/master/packages/docs/... + validations: + required: false + - type: dropdown + id: category + attributes: + label: 'Documentation Category' + description: What category does this relate to? + multiple: true + options: + - Accounts + - Backup & Restore + - Budgeting + - Development + - Installation & Configuration + - Overview + - Reports + - Troubleshooting + - Other + validations: + required: false + - type: textarea + id: expected-behavior + attributes: + label: 'Expected/Desired Content' + description: If applicable, describe what you expect to see or what should be documented + placeholder: What should the documentation say or include? + validations: + required: false + - type: textarea + id: screenshot + attributes: + label: 'Screenshots or Examples' + description: If applicable, add screenshots or examples to help explain your request + value: | + ![DESCRIPTION](LINK.png) + render: bash + validations: + required: false diff --git a/.github/actions/docs-spelling/README.md b/.github/actions/docs-spelling/README.md new file mode 100644 index 0000000000..ef73ac266b --- /dev/null +++ b/.github/actions/docs-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/packages/docs/.github/actions/spelling/advice.md b/.github/actions/docs-spelling/advice.md similarity index 55% rename from packages/docs/.github/actions/spelling/advice.md rename to .github/actions/docs-spelling/advice.md index adf884a533..cf3b282997 100644 --- a/packages/docs/.github/actions/spelling/advice.md +++ b/.github/actions/docs-spelling/advice.md @@ -3,23 +3,21 @@ <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). + +- 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. + 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). + `^` 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. +- 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. + 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. diff --git a/packages/docs/.github/actions/spelling/allow/contributers.txt b/.github/actions/docs-spelling/allow/contributers.txt similarity index 100% rename from packages/docs/.github/actions/spelling/allow/contributers.txt rename to .github/actions/docs-spelling/allow/contributers.txt diff --git a/packages/docs/.github/actions/spelling/allow/keywords.txt b/.github/actions/docs-spelling/allow/keywords.txt similarity index 100% rename from packages/docs/.github/actions/spelling/allow/keywords.txt rename to .github/actions/docs-spelling/allow/keywords.txt diff --git a/packages/docs/.github/actions/spelling/excludes.txt b/.github/actions/docs-spelling/excludes.txt similarity index 100% rename from packages/docs/.github/actions/spelling/excludes.txt rename to .github/actions/docs-spelling/excludes.txt diff --git a/packages/docs/.github/actions/spelling/expect.txt b/.github/actions/docs-spelling/expect.txt similarity index 100% rename from packages/docs/.github/actions/spelling/expect.txt rename to .github/actions/docs-spelling/expect.txt diff --git a/packages/docs/.github/actions/spelling/line_forbidden.patterns b/.github/actions/docs-spelling/line_forbidden.patterns similarity index 100% rename from packages/docs/.github/actions/spelling/line_forbidden.patterns rename to .github/actions/docs-spelling/line_forbidden.patterns diff --git a/.github/actions/docs-spelling/only.txt b/.github/actions/docs-spelling/only.txt new file mode 100644 index 0000000000..4c33031cda --- /dev/null +++ b/.github/actions/docs-spelling/only.txt @@ -0,0 +1,3 @@ +# Only check files in the packages/docs directory +^packages/docs/ + diff --git a/packages/docs/.github/actions/spelling/patterns.txt b/.github/actions/docs-spelling/patterns.txt similarity index 100% rename from packages/docs/.github/actions/spelling/patterns.txt rename to .github/actions/docs-spelling/patterns.txt diff --git a/packages/docs/.github/actions/spelling/reject.txt b/.github/actions/docs-spelling/reject.txt similarity index 100% rename from packages/docs/.github/actions/spelling/reject.txt rename to .github/actions/docs-spelling/reject.txt diff --git a/packages/docs/.github/workflows/spelling.yml b/.github/workflows/docs-spelling.yml similarity index 56% rename from packages/docs/.github/workflows/spelling.yml rename to .github/workflows/docs-spelling.yml index a21c64bc8c..7efb5128be 100644 --- a/packages/docs/.github/workflows/spelling.yml +++ b/.github/workflows/docs-spelling.yml @@ -1,4 +1,4 @@ -name: Check Spelling +name: Check Spelling (Docs) # Comment management is handled through a secondary job, for details see: # https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions @@ -36,21 +36,29 @@ name: Check Spelling on: push: branches: - - "**" + - '**' tags-ignore: - - "**" + - '**' + paths: + - 'packages/docs/**' + - '.github/workflows/docs-spelling.yml' + - '.github/actions/docs-spelling/**' pull_request_target: branches: - - "**" + - '**' tags-ignore: - - "**" + - '**' + paths: + - 'packages/docs/**' + - '.github/workflows/docs-spelling.yml' + - '.github/actions/docs-spelling/**' types: - - 'opened' - - 'reopened' - - 'synchronize' + - 'opened' + - 'reopened' + - 'synchronize' issue_comment: types: - - 'created' + - 'created' jobs: spelling: @@ -69,32 +77,32 @@ jobs: # 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: 12 - check_extra_dictionaries: '' - extra_dictionaries: - cspell:cpp/src/cpp.txt - cspell:software-terms/src/software-terms.txt - cspell:python/src/python/python-lib.txt - cspell:node/node.txt - cspell:filetypes/filetypes.txt - cspell:aws/aws.txt - cspell:typescript/dict/typescript.txt - cspell:npm/dict/npm.txt - cspell:fullstack/dict/fullstack.txt - cspell:html/dict/html.txt - cspell:css/dict/css.txt + - 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: 12 + check_extra_dictionaries: '' + extra_dictionaries: cspell:cpp/src/cpp.txt + cspell:software-terms/src/software-terms.txt + cspell:python/src/python/python-lib.txt + cspell:node/node.txt + cspell:filetypes/filetypes.txt + cspell:aws/aws.txt + cspell:typescript/dict/typescript.txt + cspell:npm/dict/npm.txt + cspell:fullstack/dict/fullstack.txt + cspell:html/dict/html.txt + cspell:css/dict/css.txt + config: .github/actions/docs-spelling comment-push: name: Report (Push) @@ -105,12 +113,13 @@ jobs: 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 }} + - 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 }} + config: .github/actions/docs-spelling comment-pr: name: Report (PR) @@ -121,13 +130,14 @@ jobs: 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 + - 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 + config: .github/actions/docs-spelling update: name: Update PR @@ -137,17 +147,18 @@ jobs: 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') + 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 }}" + - name: apply spelling updates + uses: check-spelling/check-spelling@main + with: + experimental_apply_changes_via_bot: 1 + checkout: true + ssh_key: '${{ secrets.CHECK_SPELLING }}' + config: .github/actions/docs-spelling diff --git a/packages/docs/.editorconfig b/packages/docs/.editorconfig deleted file mode 100644 index 551e30b920..0000000000 --- a/packages/docs/.editorconfig +++ /dev/null @@ -1,11 +0,0 @@ -# https://editorconfig.org - -root = true - -[*] -charset = utf-8 -end_of_line = lf -indent_size = 2 -indent_style = space -insert_final_newline = true -trim_trailing_whitespace = true diff --git a/packages/docs/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml b/packages/docs/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml deleted file mode 100644 index 41e9b98738..0000000000 --- a/packages/docs/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml +++ /dev/null @@ -1,40 +0,0 @@ -name: '🗄️ Documentation' -description: Create a new ticket for documentation you would like to create or would like creating. -title: '🗄️ [Documentation] - <title>' -labels: ['documentation'] -body: - - type: textarea - id: description - attributes: - label: 'Description' - description: Please enter an explicit description of what you would like documenting - placeholder: Short and explicit description of your idea... - validations: - required: true - - type: textarea - id: screenshot - attributes: - label: 'Screenshots' - description: If applicable, add screenshots to help explain what you would like documenting. - value: | - ![DESCRIPTION](LINK.png) - render: bash - validations: - required: false - - type: dropdown - id: category - attributes: - label: 'Category' - description: What category does this idea fall into? - multiple: true - options: - - Accounts - - Backup & Restore - - Budgeting - - Development - - Installation & Configuration - - Overview - - Reports - - Troubleshooting - validations: - required: true diff --git a/packages/docs/.github/ISSUE_TEMPLATE/IMPROVEMENT.yml b/packages/docs/.github/ISSUE_TEMPLATE/IMPROVEMENT.yml deleted file mode 100644 index 6821909b4c..0000000000 --- a/packages/docs/.github/ISSUE_TEMPLATE/IMPROVEMENT.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: '⭐ Documentation Improvement' -description: Create a new ticket to improve existing documentation. -title: '⭐ [Documentation] - <title>' -labels: ['documentation', 'enhancement'] -body: - - type: textarea - id: description - attributes: - label: 'Description' - description: Please enter a description of what needs changing - placeholder: What needs changing? - validations: - required: true - - type: input - id: url - attributes: - label: 'Documentation URL' - description: Please enter the GitHub URL to the documentation file - placeholder: ex. https://github.com/USERNAME/REPO_NAME/blob/main/docs/budgeting/categories.md - validations: - required: true diff --git a/packages/docs/.github/ISSUE_TEMPLATE/bug-report.yml b/packages/docs/.github/ISSUE_TEMPLATE/bug-report.yml deleted file mode 100644 index dcad61beb2..0000000000 --- a/packages/docs/.github/ISSUE_TEMPLATE/bug-report.yml +++ /dev/null @@ -1,58 +0,0 @@ -name: '🐛 Bug Report' -description: Create a new ticket for a bug. -title: '🐛 [BUG] - <title>' -labels: ['bug'] -body: - - type: textarea - id: description - attributes: - label: 'Description' - description: Please enter an explicit description of your issue - placeholder: Short and explicit description of your incident... - validations: - required: true - - type: input - id: reprod-url - attributes: - label: 'Reproduction URL' - description: Please enter your GitHub URL to provide a reproduction of the issue - placeholder: ex. https://github.com/USERNAME/REPO-NAME - validations: - required: true - - type: textarea - id: reprod - attributes: - label: 'Reproduction steps' - description: Please enter an explicit description of your issue - value: | - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - render: bash - validations: - required: true - - type: textarea - id: screenshot - attributes: - label: 'Screenshots' - description: If applicable, add screenshots to help explain your problem. - value: | - ![DESCRIPTION](LINK.png) - render: bash - validations: - required: false - - type: dropdown - id: browsers - attributes: - label: 'Browsers' - description: What browsers are you seeing the problem on ? - multiple: true - options: - - Firefox - - Chrome - - Safari - - Microsoft Edge - - Opera - validations: - required: false diff --git a/packages/docs/.github/ISSUE_TEMPLATE/change-request.yml b/packages/docs/.github/ISSUE_TEMPLATE/change-request.yml deleted file mode 100644 index 9072692ac4..0000000000 --- a/packages/docs/.github/ISSUE_TEMPLATE/change-request.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: '🔧 Change Request' -description: Create a new ticket for a change to the site, this doesn't include documentation. -title: '🔧 [CHANGE] - <title>' -labels: ['change'] -body: - - type: textarea - id: description - attributes: - label: 'Description' - description: Please enter an explicit description of what you would like to change - placeholder: Short and explicit description of your change idea... - validations: - required: true - - type: textarea - id: expbehav - attributes: - label: 'Expected behavior' - description: Please explain how your change should work - placeholder: Short and explicit description of your how this change should work. - validations: - required: true diff --git a/packages/docs/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/packages/docs/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md deleted file mode 100644 index 0c9e29fa38..0000000000 --- a/packages/docs/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ /dev/null @@ -1,2 +0,0 @@ -<!-- The process for Actual Budget Community Documentation pull requests is documented at https://actualbudget.org/docs/contributing/#submitting-a-pull-request --> - diff --git a/packages/docs/.github/actions/spelling/README.md b/packages/docs/.github/actions/spelling/README.md deleted file mode 100644 index 1f699f3de3..0000000000 --- a/packages/docs/.github/actions/spelling/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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/packages/docs/.github/workflows/stale.yml b/packages/docs/.github/workflows/stale.yml deleted file mode 100644 index 6ad49839c2..0000000000 --- a/packages/docs/.github/workflows/stale.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Close inactive issues -on: - schedule: - - cron: '30 1 * * *' - -jobs: - close-issues: - runs-on: ubuntu-latest - permissions: - issues: write - pull-requests: write - steps: - - uses: actions/stale@v5 - with: - days-before-issue-stale: 90 - days-before-issue-close: 30 - stale-issue-label: 'stale' - stale-issue-message: '🚧🚨 This issue is being marked as stale due to 90 days of inactivity. 🚧🚨' - close-issue-message: '🚧🚨 This issue was closed because it has been inactive for 14 days since being marked as stale. 🚧🚨' - days-before-pr-stale: -1 - days-before-pr-close: -1 - only-labels: 'needs triage' - repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/packages/docs/.gitignore b/packages/docs/.gitignore index 4a4b720f80..d858cd6517 100644 --- a/packages/docs/.gitignore +++ b/packages/docs/.gitignore @@ -1,20 +1,2 @@ -/.docusaurus -/build -/node_modules - -.DS_Store - -.idea -*.iml - -# Yarn -npm-debug.log* -yarn-debug.log* -yarn-error.log* -.pnp.* -.yarn/* -!.yarn/patches -!.yarn/plugins -!.yarn/releases -!.yarn/sdks -!.yarn/versions +.docusaurus +build diff --git a/packages/docs/.nvmrc b/packages/docs/.nvmrc deleted file mode 100644 index c4c5185671..0000000000 --- a/packages/docs/.nvmrc +++ /dev/null @@ -1 +0,0 @@ -v22/* diff --git a/packages/docs/.prettierignore b/packages/docs/.prettierignore deleted file mode 100644 index d858cd6517..0000000000 --- a/packages/docs/.prettierignore +++ /dev/null @@ -1,2 +0,0 @@ -.docusaurus -build diff --git a/packages/docs/.prettierrc.json b/packages/docs/.prettierrc.json deleted file mode 100644 index 5393aaf2da..0000000000 --- a/packages/docs/.prettierrc.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "singleQuote": true, - "trailingComma": "all", - "arrowParens": "avoid" -} diff --git a/packages/docs/CONTRIBUTING.md b/packages/docs/CONTRIBUTING.md deleted file mode 100644 index 2f412f3574..0000000000 --- a/packages/docs/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -Please review the contributing documentation on our website: https://actualbudget.org/docs/contributing/ diff --git a/packages/docs/package.json b/packages/docs/package.json index 035a06e84b..ffb55076d3 100644 --- a/packages/docs/package.json +++ b/packages/docs/package.json @@ -16,12 +16,12 @@ "lint": "prettier --check ." }, "dependencies": { - "@docusaurus/core": "^3.9.1", - "@docusaurus/plugin-content-docs": "^3.9.1", - "@docusaurus/plugin-ideal-image": "^3.9.1", - "@docusaurus/preset-classic": "^3.9.1", - "@docusaurus/theme-common": "^3.9.1", - "@docusaurus/theme-mermaid": "^3.9.1", + "@docusaurus/core": "^3.9.2", + "@docusaurus/plugin-content-docs": "^3.9.2", + "@docusaurus/plugin-ideal-image": "^3.9.2", + "@docusaurus/preset-classic": "^3.9.2", + "@docusaurus/theme-common": "^3.9.2", + "@docusaurus/theme-mermaid": "^3.9.2", "@easyops-cn/docusaurus-search-local": "^0.52.1", "@mdx-js/react": "^3.1.1", "@r74tech/docusaurus-plugin-panzoom": "^2.4.0", @@ -31,8 +31,8 @@ "react-dom": "^19.2.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^3.9.1", - "@types/react": "^19.2.0", + "@docusaurus/module-type-aliases": "^3.9.2", + "@types/react": "^19.2.2", "prettier": "^3.6.2" }, "browserslist": { @@ -46,9 +46,5 @@ "last 1 firefox version", "last 1 safari version" ] - }, - "engines": { - "node": ">=22" - }, - "packageManager": "yarn@4.10.3" + } } diff --git a/upcoming-release-notes/6095.md b/upcoming-release-notes/6095.md new file mode 100644 index 0000000000..b885b2fef2 --- /dev/null +++ b/upcoming-release-notes/6095.md @@ -0,0 +1,6 @@ +--- +category: Maintenance +authors: [matt-fidd] +--- + +Initial cleanup following the docs repository merge diff --git a/yarn.lock b/yarn.lock index d3dc065a97..11a1aa739c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2983,7 +2983,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/core@npm:3.9.2, @docusaurus/core@npm:^3.9.1": +"@docusaurus/core@npm:3.9.2, @docusaurus/core@npm:^3.9.2": version: 3.9.2 resolution: "@docusaurus/core@npm:3.9.2" dependencies: @@ -3109,7 +3109,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/module-type-aliases@npm:3.9.2, @docusaurus/module-type-aliases@npm:^3.9.1": +"@docusaurus/module-type-aliases@npm:3.9.2, @docusaurus/module-type-aliases@npm:^3.9.2": version: 3.9.2 resolution: "@docusaurus/module-type-aliases@npm:3.9.2" dependencies: @@ -3157,7 +3157,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/plugin-content-docs@npm:3.9.2, @docusaurus/plugin-content-docs@npm:^2 || ^3, @docusaurus/plugin-content-docs@npm:^3.9.1": +"@docusaurus/plugin-content-docs@npm:3.9.2, @docusaurus/plugin-content-docs@npm:^2 || ^3, @docusaurus/plugin-content-docs@npm:^3.9.2": version: 3.9.2 resolution: "@docusaurus/plugin-content-docs@npm:3.9.2" dependencies: @@ -3281,7 +3281,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/plugin-ideal-image@npm:^3.9.1": +"@docusaurus/plugin-ideal-image@npm:^3.9.2": version: 3.9.2 resolution: "@docusaurus/plugin-ideal-image@npm:3.9.2" dependencies: @@ -3344,7 +3344,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/preset-classic@npm:^3.9.1": +"@docusaurus/preset-classic@npm:^3.9.2": version: 3.9.2 resolution: "@docusaurus/preset-classic@npm:3.9.2" dependencies: @@ -3423,7 +3423,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/theme-common@npm:3.9.2, @docusaurus/theme-common@npm:^3.9.1": +"@docusaurus/theme-common@npm:3.9.2, @docusaurus/theme-common@npm:^3.9.2": version: 3.9.2 resolution: "@docusaurus/theme-common@npm:3.9.2" dependencies: @@ -3447,7 +3447,7 @@ __metadata: languageName: node linkType: hard -"@docusaurus/theme-mermaid@npm:^3.9.1": +"@docusaurus/theme-mermaid@npm:^3.9.2": version: 3.9.2 resolution: "@docusaurus/theme-mermaid@npm:3.9.2" dependencies: @@ -9319,7 +9319,7 @@ __metadata: languageName: node linkType: hard -"@types/react@npm:*, @types/react@npm:^19.2.0, @types/react@npm:^19.2.2": +"@types/react@npm:*, @types/react@npm:^19.2.2": version: 19.2.2 resolution: "@types/react@npm:19.2.2" dependencies: @@ -14260,17 +14260,17 @@ __metadata: version: 0.0.0-use.local resolution: "docs@workspace:packages/docs" dependencies: - "@docusaurus/core": "npm:^3.9.1" - "@docusaurus/module-type-aliases": "npm:^3.9.1" - "@docusaurus/plugin-content-docs": "npm:^3.9.1" - "@docusaurus/plugin-ideal-image": "npm:^3.9.1" - "@docusaurus/preset-classic": "npm:^3.9.1" - "@docusaurus/theme-common": "npm:^3.9.1" - "@docusaurus/theme-mermaid": "npm:^3.9.1" + "@docusaurus/core": "npm:^3.9.2" + "@docusaurus/module-type-aliases": "npm:^3.9.2" + "@docusaurus/plugin-content-docs": "npm:^3.9.2" + "@docusaurus/plugin-ideal-image": "npm:^3.9.2" + "@docusaurus/preset-classic": "npm:^3.9.2" + "@docusaurus/theme-common": "npm:^3.9.2" + "@docusaurus/theme-mermaid": "npm:^3.9.2" "@easyops-cn/docusaurus-search-local": "npm:^0.52.1" "@mdx-js/react": "npm:^3.1.1" "@r74tech/docusaurus-plugin-panzoom": "npm:^2.4.0" - "@types/react": "npm:^19.2.0" + "@types/react": "npm:^19.2.2" clsx: "npm:^2.1.1" prettier: "npm:^3.6.2" prism-react-renderer: "npm:^2.4.1"