Clean up typos in docs, comments, and UI copy#6045
Open
PeterDaveHello wants to merge 1 commit intoStirling-Tools:mainfrom
Open
Clean up typos in docs, comments, and UI copy#6045PeterDaveHello wants to merge 1 commit intoStirling-Tools:mainfrom
PeterDaveHello wants to merge 1 commit intoStirling-Tools:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up typos and improves consistency in documentation, comments, and user-facing text across the repo.
Changes:
- Fixes wording/grammar issues in multiple markdown guides and template docs.
- Corrects typos in frontend/backend comments and UI error text.
- Updates a few path/script references in documentation to match current repo structure.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| testing/cucumber/exampleFiles/example.md | Fixes markdown list formatting/typo in example content. |
| README.md | Cleans up Support section bullet formatting and “GitHub” capitalization. |
| frontend/src/proprietary/constants/staticStripeLinks.ts | Fixes a typo in a comment (“PRODUCTION”). |
| frontend/src/core/tests/test-fixtures/README.md | Corrects the documented fixtures directory path. |
| frontend/src/core/services/googleDrivePickerService.ts | Fixes typo in an error message (token handling path). |
| frontend/README.md | Minor grammar fix in environment variable guidance. |
| docs/type3_fallback_plan.md | Updates the referenced PDF download script name in the workflow table. |
| devGuide/STYLELINT.md | Fixes Stylelint command paths/config reference in docs. |
| devGuide/DeveloperGuide.md | Minor wording/grammar fixes in build notes. |
| DeveloperGuide.md | Fixes numbering and wording/grammar in setup/build notes. |
| app/proprietary/src/main/resources/templates/AUDIT_USAGE.md | Grammar fix in audit event description. |
| app/common/src/main/java/stirling/software/common/configuration/AppConfig.java | Comment wording fix (“use case”). |
Comments suppressed due to low confidence (1)
frontend/src/core/services/googleDrivePickerService.ts:164
- When
response.access_tokenis null,reject(...)is called but execution continues, settingthis.accessTokento null and then callingresolve(). Add an earlyreturn(or structure withelse) after the reject to prevent resolving the promise on an error path.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
6a3724f to
cec446b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Documentation
Translations (if applicable)
scripts/counter_translation.pyUI Changes (if applicable)
Testing (if applicable)