Skip to content

Commit cec446b

Browse files
Clean up typos in docs, comments, and UI copy
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.
1 parent 3c48740 commit cec446b

12 files changed

Lines changed: 16 additions & 16 deletions

File tree

DeveloperGuide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Visit the [Lombok website](https://projectlombok.org/setup/) for installation in
7979
8080
5. Add environment variable
8181
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.
82-
5. **Frontend Setup (Required for Stirling 2.0)**
82+
6. **Frontend Setup (Required for Stirling 2.0)**
8383
Navigate to the frontend directory and install dependencies using npm.
8484
8585
## 4. Stirling 2.0 Development Workflow
@@ -227,7 +227,7 @@ Stirling-PDF uses different Docker images for various configurations. The build
227227
1. Set the security environment variable:
228228
229229
```bash
230-
export DISABLE_ADDITIONAL_FEATURES=true # or false for to enable login and security features for builds
230+
export DISABLE_ADDITIONAL_FEATURES=true # or false to enable login and security features for builds
231231
```
232232
233233
2. Build the project with Gradle:
@@ -257,7 +257,7 @@ Stirling-PDF uses different Docker images for various configurations. The build
257257
docker build --no-cache --pull --build-arg VERSION_TAG=alpha -t stirlingtools/stirling-pdf:latest-fat -f ./Dockerfile.fat .
258258
```
259259
260-
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
260+
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
261261

262262
## 7. Testing
263263

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ For full installation options (including desktop and Kubernetes), see our [Docum
5353

5454
## Support
5555

56-
- **Community** [Discord](https://discord.gg/HYmhKj45pU)
57-
- **Bug Reports**: [Github issues](https://github.com/Stirling-Tools/Stirling-PDF/issues)
56+
- **Community**: [Discord](https://discord.gg/HYmhKj45pU)
57+
- **Bug Reports**: [GitHub Issues](https://github.com/Stirling-Tools/Stirling-PDF/issues)
5858

5959
## Contributing
6060

app/common/src/main/java/stirling/software/common/configuration/AppConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ public boolean isRunningInDockerWithConfig() {
133133
return true;
134134
}
135135
Path mountInfo = Paths.get("/proc/1/mountinfo");
136-
// this should always exist, if not some unknown usecase
136+
// this should always exist, if not some unknown use case
137137
if (!Files.exists(mountInfo)) {
138138
return true;
139139
}

app/proprietary/src/main/resources/templates/AUDIT_USAGE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ Use consistent event types throughout the application:
223223
- `FILE_DOWNLOAD` - When a file is downloaded
224224
- `PDF_PROCESS` - When a PDF is processed (split, merged, etc.)
225225
- `USER_CREATE` - When a user is created
226-
- `USER_UPDATE` - When a user details are updated
226+
- `USER_UPDATE` - When a user's details are updated
227227
- `PASSWORD_CHANGE` - When a password is changed
228228
- `PERMISSION_CHANGE` - When permissions are modified
229229
- `SETTINGS_CHANGE` - When system settings are changed

devGuide/DeveloperGuide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Stirling-PDF uses different Docker images for various configurations. The build
175175
1. Set the security environment variable:
176176
177177
```bash
178-
export DISABLE_ADDITIONAL_FEATURES=true # or false for to enable login and security features for builds
178+
export DISABLE_ADDITIONAL_FEATURES=true # or false to enable login and security features for builds
179179
```
180180
181181
2. Build the project with Gradle:
@@ -205,7 +205,7 @@ Stirling-PDF uses different Docker images for various configurations. The build
205205
docker build --no-cache --pull --build-arg VERSION_TAG=alpha -t stirlingtools/stirling-pdf:latest-fat -f ./Dockerfile.fat .
206206
```
207207
208-
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
208+
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
209209

210210
## 6. Testing
211211

devGuide/STYLELINT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Apply Stylelint to your project's CSS with the following steps:
1818
{
1919
"scripts": {
2020
"lint:css:check": "stylelint \"../app/core/src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config ../.stylelintrc.json",
21-
"lint:css:fix": "stylelint \"../app/core//src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config .stylelintrc.json --fix"
21+
"lint:css:fix": "stylelint \"../app/core/src/main/**/*.css\" \"../app/proprietary/src/main/resources/static/css/*.css\" --config ../.stylelintrc.json --fix"
2222
}
2323
}
2424
```

docs/type3_fallback_plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Feel free to expand this plan or add notes as the work progresses.
132132

133133
| Stage | Tool / Command | Output |
134134
| --- | --- | --- |
135-
| 1. Collect PDFs | `python scripts/download_pdf_collection.py --output scripts/pdf-collection` (or drop your own PDFs anywhere) | Raw PDFs ready for harvesting |
135+
| 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 |
136136
| 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` |
137137
| 3. Summarize backlog | `python scripts/summarize_type3_signatures.py` | `docs/type3/signature_inventory.md` (human checklist of aliases/signatures) |
138138
| 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/<family>/`. | Canonical font binaries |

frontend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
The frontend requires environment variables to be set before running. `npm run dev` will create a `.env` file for you automatically on first run using the defaults from `config/.env.example` - for most development work this is all you need.
55

6-
If you need to configure specific services (Google Drive, Supabase, Stripe, PostHog), edit your local `.env` file. The values in `config/.env.example` show what each variable does and provides sensible defaults where applicable.
6+
If you need to configure specific services (Google Drive, Supabase, Stripe, PostHog), edit your local `.env` file. The values in `config/.env.example` show what each variable does and provide sensible defaults where applicable.
77

88
For desktop (Tauri) development, `npm run tauri-dev` will additionally create a `.env.desktop` file from `config/.env.desktop.example`.
99

frontend/src/core/services/googleDrivePickerService.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ class GoogleDrivePickerService {
155155
return;
156156
}
157157
if(response.access_token == null){
158-
reject(new Error("No acces token in response"));
158+
reject(new Error("No access token in response"));
159159
}
160160

161161
this.accessToken = response.access_token;

frontend/src/core/tests/test-fixtures/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ To run the full test suite, please add the following test files to this director
9393
## Test File Structure
9494

9595
```
96-
frontend/src/tests/test-fixtures/
96+
frontend/src/core/tests/test-fixtures/
9797
├── README.md (this file)
9898
├── sample.pdf
9999
├── sample.docx

0 commit comments

Comments
 (0)