docs: fix vale linting for the version3 of the docs #605
Conversation
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
|
To generate Unit Tests for this PR, please click here. |
There was a problem hiding this comment.
Pull Request Overview
This PR resolves Vale linting issues in the version 3 documentation by correcting punctuation, spelling, and style inconsistencies.
- Standardized punctuation (e.g., replaced hyphens with em dashes, added or removed periods).
- Fixed spelling and capitalization errors across multiple docs.
- Updated Vale vocabulary configuration to accept project-specific terms.
Reviewed Changes
Copilot reviewed 36 out of 46 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-3.0.0/running-keploy/utg-pr-agent.md | Added terminal period for consistency |
| versioned_docs/version-3.0.0/running-keploy/test-generate.md | Replaced hyphen range (3–5) with em dash (3—5) |
| versioned_docs/version-3.0.0/running-keploy/share-tests.md | Swapped hyphens for em dashes in list items |
| versioned_docs/version-3.0.0/running-keploy/run-ai-generated-api-tests.md | Applied em dashes and fixed list punctuation |
| versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md | Applied em dashes in headings and lists |
| versioned_docs/version-3.0.0/running-keploy/keploy-templatize.md | Corrected “subequent” → “subsequent” |
| versioned_docs/version-3.0.0/running-keploy/cli-commands.md | Harmonized punctuation on flag descriptions |
| versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md | Swapped hyphens for em dashes in table |
| versioned_docs/version-3.0.0/running-keploy/api-testing-chrome-extension.md | Swapped hyphens for em dashes in list items |
| versioned_docs/version-3.0.0/quickstart/samples-node-mongo.md | Fixed heading spelling (“Intoduction” → “Introduction”) and “Wohoo” → “Woohoo” |
| versioned_docs/version-3.0.0/quickstart/samples-java.md | Changed numeric notation (10s → 10's) |
| versioned_docs/version-3.0.0/quickstart/samples-go-sse-svelte.md | Corrected “applicaiton” → “application” |
| versioned_docs/version-3.0.0/quickstart/samples-echo.md | Fixed code punctuation and “genereate” → “generate” |
| versioned_docs/version-3.0.0/quickstart/samples-bunjs.md | Fixed “essentailly” → “essentially” |
| versioned_docs/version-3.0.0/quickstart/sample-rust-crud-mongo.md | Corrected “peformed” → “performed” |
| versioned_docs/version-3.0.0/quickstart/node-express-mongoose.md | Lowercased “mongodb” for consistency |
| versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md | Changed numeric notation (10s → 10's) |
| versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md | Lowercased “openhospital” |
| versioned_docs/version-3.0.0/operation/record.md | Fixed “KTest” → “KTests” directory reference |
| versioned_docs/version-3.0.0/operation/browser-extension.md | Capitalized “First” and fixed “moc” → “mock” |
| versioned_docs/version-3.0.0/keploy-explained/why-keploy.md | Swapped hyphen for em dash in sentence continuation |
| versioned_docs/version-3.0.0/keploy-explained/testing-guide.md | Changed “4th” → “Fourth” |
| versioned_docs/version-3.0.0/keploy-cloud/time-freezing.md | Removed duplicate “the” |
| versioned_docs/version-3.0.0/keploy-cloud/testgeneration.md | Removed duplicate “create” |
| versioned_docs/version-3.0.0/keploy-cloud/keploy-console.md | Expanded “param” → “parameter” in description |
| versioned_docs/version-3.0.0/keploy-cloud/deduplication.md | Removed duplicate “the” |
| versioned_docs/version-3.0.0/hacktoberfest/contribution-guide.md | Fixed spelling (“Contributribution” → “Contribution”) |
| versioned_docs/version-3.0.0/dependencies/mongo.md | Corrected duplicate “the” |
| versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md | Fixed bold formatting on “Continuous” |
| versioned_docs/version-3.0.0/concepts/reference/glossary/unit-test-automation.md | Changed alt text image label |
| versioned_docs/version-3.0.0/concepts/reference/glossary/software-testing-life-cycle.md | Removed double space before “accelerating” |
| versioned_docs/version-3.0.0/concepts/reference/glossary/black-box-testing.md | Fixed “Whate” → “What” |
| versioned_docs/version-3.0.0/concepts/reference/glossary/ai-test-completion.md | Corrected “LLM's” → “LLMs” |
| versioned_docs/version-3.0.0/concepts/installation.md | Fixed “Wohoo” → “Woohoo” and “Prequisites” → “Prerequisites” |
| versioned_docs/version-3.0.0/ci-cd/github.md | Fixed “yout” → “your” and “worflow” → “workflow” |
| vale_styles/config/vocabularies/Base/accept.txt | Added many project-specific terms to Vale vocabulary |
Comments suppressed due to low confidence (1)
versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md:56
- Properly capitalize the API name: use 'OpenHospital' instead of 'openhospital' to match project conventions.
Now it's time to setup the backend of our application. Let's Install the openhospital API and get started.
| @@ -26,7 +26,7 @@ You can use the following command to templatize your testsets. | |||
| sudo -E env 'PATH=$PATH' keploy templatize | |||
| ``` | |||
|
|
|||
| By default, it templatizes all the testsets in the keploy folder. If you want to templatize a particular testset, you can pass the testset flag like | |||
| By default, it templatizes all the testsets in the keploy folder. If you want to templatizes a particular testsets, you can pass the testsets flag like | |||
There was a problem hiding this comment.
Correct the verb and noun forms: change 'templatizes' to 'templatize' and 'testsets' to 'testset', e.g., 'If you want to templatize a particular testset, ...'.
Copilot uses AI. Check for mistakes.
versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md
Outdated
Show resolved
Hide resolved
| @@ -139,7 +139,7 @@ JUnit 5 is the next generation of the JUnit framework, introducing new features | |||
| ### TestNG (Java): | |||
|
|
|||
| TestNG is another testing framework for Java, designed to cover a broader range of testing categories, including unit, functional, and integration testing. It supports parallel execution, data-driven testing, and easy configuration through annotations. | |||
|  | |||
|  | |||
There was a problem hiding this comment.
The alt text should reflect the image content; replace 'testing' with 'testng' to match the filename.
Suggested change
|  | |
|  |
Copilot uses AI. Check for mistakes.
| @@ -67,7 +67,7 @@ Software Testing Life Cycle (STLC) comprises several phases that guide the testi | |||
| - **Risk-Based Testing**: Prioritize tests based on potential impact and likelihood of failure. | |||
| - **Performance Testing**: Evaluate software performance under various conditions and loads. | |||
|
|
|||
| ## How Keploy helps in accelrating the Software Testing Life Cycle process? | |||
| ## How Keploy helps in accelerating the Software Testing Life Cycle process? | |||
There was a problem hiding this comment.
Remove the extra space between 'in' and 'accelerating'.
Suggested change
| ## How Keploy helps in accelerating the Software Testing Life Cycle process? | |
| ## How Keploy helps in accelerating the Software Testing Life Cycle process? |
Copilot uses AI. Check for mistakes.
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.
Overview
This PR addresses and resolves Vale linting issues present in the documentation for version 3. All Vale-detected warnings and errors have been reviewed and corrected to ensure our documentation meets our style and quality standards.
Changes Made
Testing