From 16cfbc170e8351bc5879589f0f8a37babdfad90e Mon Sep 17 00:00:00 2001 From: Peter Dave Hello <3691490+PeterDaveHello@users.noreply.github.com> Date: Mon, 6 Jul 2026 22:07:06 +0800 Subject: [PATCH] Clean up typos in docs, comments, and UI copy (#6045) # Description of Changes Fix wording, numbering, path references, and minor grammar issues across project guides, backend comments, and frontend strings. This keeps documentation and user-facing text consistent without changing application behavior. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details. Co-authored-by: James Brunton --- DeveloperGuide.md | 6 +++--- README.md | 4 ++-- .../stirling/software/common/configuration/AppConfig.java | 2 +- app/proprietary/src/main/resources/templates/AUDIT_USAGE.md | 2 +- devGuide/STYLELINT.md | 4 ++-- docs/type3_fallback_plan.md | 2 +- .../editor/src/core/services/googleDrivePickerService.ts | 2 +- frontend/editor/src/core/tests/test-fixtures/README.md | 2 +- .../editor/src/proprietary/constants/staticStripeLinks.ts | 2 +- testing/cucumber/exampleFiles/example.md | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) diff --git a/DeveloperGuide.md b/DeveloperGuide.md index 23b2652ce1..fbbf6478ac 100644 --- a/DeveloperGuide.md +++ b/DeveloperGuide.md @@ -92,7 +92,7 @@ Visit the [Lombok website](https://projectlombok.org/setup/) for installation in 5. Add environment variable For local testing, you should generally be testing the full 'Security' version of Stirling PDF. To do this, you must add the environment flag DISABLE_ADDITIONAL_FEATURES=false to your system and/or IDE build/run step. -5. **Frontend Setup (Required for Stirling 2.0)** +6. **Frontend Setup (Required for Stirling 2.0)** Navigate to the frontend directory and install dependencies using npm. ### Verify Setup @@ -275,7 +275,7 @@ Stirling-PDF uses different Docker images for various configurations. The build 1. Set the security environment variable: ```bash - export DISABLE_ADDITIONAL_FEATURES=true # or false for to enable login and security features for builds + export DISABLE_ADDITIONAL_FEATURES=true # or false to enable login and security features for builds ``` 2. Build the project: @@ -305,7 +305,7 @@ Stirling-PDF uses different Docker images for various configurations. The build docker build --no-cache --pull --build-arg VERSION_TAG=alpha -t stirlingtools/stirling-pdf:latest-fat -f ./Dockerfile.fat . ``` -Note: The `--no-cache` and `--pull` flags ensure that the build process uses the latest base images and doesn't use cached layers, which is useful for testing and ensuring reproducible builds. however to improve build times these can often be removed depending on your usecase +Note: The `--no-cache` and `--pull` flags ensure that the build process uses the latest base images and doesn't use cached layers, which is useful for testing and ensuring reproducible builds. However, to improve build times these can often be removed depending on your use case ## 7. Testing diff --git a/README.md b/README.md index c1d96eca1d..c6777f1032 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,8 @@ For full installation options (including desktop and Kubernetes), see our [Docum ## Support -- **Community** [Discord](https://discord.gg/HYmhKj45pU) -- **Bug Reports**: [Github issues](https://github.com/Stirling-Tools/Stirling-PDF/issues) +- **Community**: [Discord](https://discord.gg/HYmhKj45pU) +- **Bug Reports**: [GitHub Issues](https://github.com/Stirling-Tools/Stirling-PDF/issues) ## Contributing diff --git a/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java b/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java index ba896b4e34..40c1c98f23 100644 --- a/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java +++ b/app/common/src/main/java/stirling/software/common/configuration/AppConfig.java @@ -132,7 +132,7 @@ public class AppConfig { return true; } Path mountInfo = Path.of("/proc/1/mountinfo"); - // this should always exist, if not some unknown usecase + // this should always exist, if not some unknown use case if (!Files.exists(mountInfo)) { return true; } diff --git a/app/proprietary/src/main/resources/templates/AUDIT_USAGE.md b/app/proprietary/src/main/resources/templates/AUDIT_USAGE.md index 57cdce61b5..58702d3524 100644 --- a/app/proprietary/src/main/resources/templates/AUDIT_USAGE.md +++ b/app/proprietary/src/main/resources/templates/AUDIT_USAGE.md @@ -223,7 +223,7 @@ Use consistent event types throughout the application: - `FILE_DOWNLOAD` - When a file is downloaded - `PDF_PROCESS` - When a PDF is processed (split, merged, etc.) - `USER_CREATE` - When a user is created -- `USER_UPDATE` - When a user details are updated +- `USER_UPDATE` - When a user's details are updated - `PASSWORD_CHANGE` - When a password is changed - `PERMISSION_CHANGE` - When permissions are modified - `SETTINGS_CHANGE` - When system settings are changed diff --git a/devGuide/STYLELINT.md b/devGuide/STYLELINT.md index 04ddc407a1..0e279e1915 100644 --- a/devGuide/STYLELINT.md +++ b/devGuide/STYLELINT.md @@ -17,8 +17,8 @@ Apply Stylelint to your project's CSS with the following steps: ```jsonc { "scripts": { - "lint:css:check": "stylelint \"../app/core/src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config ../.stylelintrc.json", - "lint:css:fix": "stylelint \"../app/core//src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json --fix" + "lint:css:check": "stylelint \"../app/core/src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json", + "lint:css:fix": "stylelint \"../app/core/src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json --fix" } } ``` diff --git a/docs/type3_fallback_plan.md b/docs/type3_fallback_plan.md index 3ef7e6ad2a..f49514585a 100644 --- a/docs/type3_fallback_plan.md +++ b/docs/type3_fallback_plan.md @@ -132,7 +132,7 @@ Feel free to expand this plan or add notes as the work progresses. | Stage | Tool / Command | Output | | --- | --- | --- | -| 1. Collect PDFs | `python scripts/download_pdf_collection.py --output scripts/pdf-collection` (or drop your own PDFs anywhere) | Raw PDFs ready for harvesting | +| 1. Collect PDFs | `python scripts/download_pdf_samples.py --output-dir scripts/pdf-collection` (or drop your own PDFs anywhere) | Raw PDFs ready for harvesting | | 2. Harvest signatures | `python scripts/harvest_type3_fonts.py --input scripts/pdf-collection --pretty` | Per-PDF dumps in `docs/type3/signatures/…` + global summary `docs/type3/harvest_report.json` | | 3. Summarize backlog | `python scripts/summarize_type3_signatures.py` | `docs/type3/signature_inventory.md` (human checklist of aliases/signatures) | | 4. Convert fonts | Either copy the upstream TTF/OTF for the font (DejaVu, CM, STIX, etc.) or run `scripts/type3_to_cff.py` against the harvested glyph JSON to synthesize one offline; store the result under `app/core/src/main/resources/type3/library/fonts//`. | Canonical font binaries | diff --git a/frontend/editor/src/core/services/googleDrivePickerService.ts b/frontend/editor/src/core/services/googleDrivePickerService.ts index ac4dbd116d..9d91ffdeac 100644 --- a/frontend/editor/src/core/services/googleDrivePickerService.ts +++ b/frontend/editor/src/core/services/googleDrivePickerService.ts @@ -155,7 +155,7 @@ class GoogleDrivePickerService { return; } if (response.access_token == null) { - reject(new Error("No acces token in response")); + reject(new Error("No access token in response")); } this.accessToken = response.access_token; diff --git a/frontend/editor/src/core/tests/test-fixtures/README.md b/frontend/editor/src/core/tests/test-fixtures/README.md index 32e64b3469..079bd401d0 100644 --- a/frontend/editor/src/core/tests/test-fixtures/README.md +++ b/frontend/editor/src/core/tests/test-fixtures/README.md @@ -93,7 +93,7 @@ To run the full test suite, please add the following test files to this director ## Test File Structure ``` -frontend/src/tests/test-fixtures/ +frontend/editor/src/core/tests/test-fixtures/ ├── README.md (this file) ├── sample.pdf ├── sample.docx diff --git a/frontend/editor/src/proprietary/constants/staticStripeLinks.ts b/frontend/editor/src/proprietary/constants/staticStripeLinks.ts index 6b78a09fd5..bb38aa218b 100644 --- a/frontend/editor/src/proprietary/constants/staticStripeLinks.ts +++ b/frontend/editor/src/proprietary/constants/staticStripeLinks.ts @@ -17,7 +17,7 @@ export interface StaticStripeLinks { }; billingPortal: string; } -// PRODCUTION LINKS FOR LIVE SERVER +// PRODUCTION LINKS FOR LIVE SERVER export const STATIC_STRIPE_LINKS: StaticStripeLinks = { server: { monthly: "https://buy.stripe.com/fZu4gB8Nv6ysfAj0ts8Zq03", diff --git a/testing/cucumber/exampleFiles/example.md b/testing/cucumber/exampleFiles/example.md index 10bb117bad..6e51c608f3 100644 --- a/testing/cucumber/exampleFiles/example.md +++ b/testing/cucumber/exampleFiles/example.md @@ -11,6 +11,6 @@ text2 ### **Page Operations** -- View and modify PDFs - View multi page PDFs with custom viewing sorting and searching. Plus on page edit features like annotate, draw and adding text and images. (Using PDF.js with Joxit and Liberation.Liberation fonts) +- View and modify PDFs - View multi page PDFs with custom viewing sorting and searching. Plus on page edit features like annotate, draw and adding text and images. (Using PDF.js with Joxit and Liberation fonts) - Full interactive GUI for merging/splitting/rotating/moving PDFs and their pages. - Merge multiple PDFs together into a single resultant file. \ No newline at end of file