docs: fix the linters for the version3 #611
Open
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
|
No significant changes currently retry |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes Vale linting issues across the version 3 documentation by addressing grammar, style, punctuation, and configuration updates to meet style guidelines.
- Corrected typos, punctuation, and dash usage in markdown files flagged by Vale
- Standardized headings, list separators, and asset references for consistency
- Expanded Vale vocabulary in configuration to support new terms
Reviewed Changes
Copilot reviewed 37 out of 45 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-3.0.0/running-keploy/utg-vsc-extension.md | Removed escape sequence before underscore |
| versioned_docs/version-3.0.0/running-keploy/utg-pr-agent.md | Adjusted period placement in UI instructions |
| versioned_docs/version-3.0.0/running-keploy/test-generate.md | Standardized numeric range punctuation |
| versioned_docs/version-3.0.0/running-keploy/share-tests.md | Converted list separators to em dashes |
| versioned_docs/version-3.0.0/running-keploy/run-ai-generated-api-tests.md | Updated table and list punctuation |
| versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md | Unified dash style and refined heading |
| versioned_docs/version-3.0.0/running-keploy/keploy-templatize.md | Fixed grammar in flag description |
| versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md | Adjusted table separator formatting |
| versioned_docs/version-3.0.0/running-keploy/cli-commands.md | Harmonized flag description punctuation and grammar |
| versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md | Standardized dash usage in metrics table |
| versioned_docs/version-3.0.0/running-keploy/api-testing-chrome-extension.md | Replaced hyphens with em dashes in list items |
| versioned_docs/version-3.0.0/quickstart/samples-node-mongo.md | Corrected spelling in section headings |
| versioned_docs/version-3.0.0/quickstart/samples-java.md | Fixed apostrophe usage in time unit description |
| versioned_docs/version-3.0.0/quickstart/samples-go-sse-svelte.md | Corrected typo in ‘application’ |
| versioned_docs/version-3.0.0/quickstart/samples-echo.md | Adjusted code punctuation and spelling |
| versioned_docs/version-3.0.0/quickstart/samples-bunjs.md | Corrected ‘essentially’ spelling |
| versioned_docs/version-3.0.0/quickstart/sample-rust-crud-mongo.md | Fixed ‘performed’ typo |
| versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md | Fixed apostrophe usage in time unit description |
| versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md | Fixed apostrophe usage in time unit description |
| versioned_docs/version-3.0.0/quickstart/go-mux-sql.md | Corrected ‘catalog’ spelling |
| versioned_docs/version-3.0.0/operation/record.md | Updated test-path reference capitalization |
| versioned_docs/version-3.0.0/operation/browser-extension.md | Refined title casing and fixed typo |
| versioned_docs/version-3.0.0/keploy-explained/why-keploy.md | Standardized dash punctuation |
| versioned_docs/version-3.0.0/keploy-explained/testing-guide.md | Adjusted step notation |
| versioned_docs/version-3.0.0/keploy-explained/api-testing-faq.md | Unified list item separators |
| versioned_docs/version-3.0.0/keploy-cloud/time-freezing.md | Removed duplicate word |
| versioned_docs/version-3.0.0/keploy-cloud/testgeneration.md | Removed duplicated term |
| versioned_docs/version-3.0.0/keploy-cloud/deduplication.md | Removed duplicate word |
| versioned_docs/version-3.0.0/hacktoberfest/contribution-guide.md | Corrected ‘Contribution’ spelling |
| versioned_docs/version-3.0.0/dependencies/mongo.md | Minor formatting consistency |
| versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md | Updated asset URL and heading punctuation |
| versioned_docs/version-3.0.0/concepts/reference/glossary/unit-test-automation.md | Fixed alt text for accessibility |
| versioned_docs/version-3.0.0/concepts/reference/glossary/software-testing-life-cycle.md | Corrected ‘accelerating’ spelling |
| versioned_docs/version-3.0.0/concepts/reference/glossary/black-box-testing.md | Fixed heading punctuation |
| versioned_docs/version-3.0.0/concepts/installation.md | Corrected ‘Woohoo!’ typo |
| versioned_docs/version-3.0.0/ci-cd/github.md | Fixed typos in GitHub workflow instructions |
| vale_styles/config/vocabularies/Base/accept.txt | Expanded vocabulary list for Vale |
Comments suppressed due to low confidence (11)
versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md:76
- [nitpick] The heading only mentions editing or deleting but the list includes adding and selecting suites; consider renaming it to 'Manage Test Suites' for clarity.
## Edit or Delete a Test Suite
versioned_docs/version-3.0.0/quickstart/samples-echo.md:130
- The trailing period should be outside the code span; code should remain '
header.data' without the period inside.
**1. On line 32 we will add "`- body.ts`" under the "`header.data`."**
versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md:31
- Use a relative path for local assets (e.g., '../../../../../static/img/glossary/types-of-testing.jpeg') to avoid external dependencies.
versioned_docs/version-3.0.0/running-keploy/test-generate.md:50
- Use an en dash (–) instead of an em dash (—) for numeric ranges (e.g., 3–5).
#### 📎 Paste cURL Snippets _(Recommended: 3—5)_
versioned_docs/version-3.0.0/running-keploy/keploy-templatize.md:29
- Grammar: use singular 'test set' and refer to the correct flag name, e.g., 'If you want to templatize a particular test set, pass the --testset flag'.
By default, it templatizes all the testsets in the keploy folder. If you want to templatize a particular testsets, you can pass the testsets flag like
versioned_docs/version-3.0.0/running-keploy/cli-commands.md:302
- Add a space after the backtick in '
rerecordcmd', fix verb agreement ('allows users'), and clarify 'test sets'.
The `rerecord`cmd allow user to record new keploy testcases/mocks from the existing test cases for the given testsets.
versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md:29
- Use en dashes (30–50% and 50–80%) for numeric ranges instead of em dashes.
| 30—50% of time spent writing tests | 50—80% reduction in test creation <br/> Covers more edge cases within limited resources, time |
versioned_docs/version-3.0.0/quickstart/samples-java.md:289
- Remove the apostrophe in '10's'; use '10s' to indicate seconds.
Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10's to get started, you can change the `delay` accordingly.
versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md:148
- Remove the apostrophe in '10's'; use '10s' for seconds.
Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10's to get started, you can change the `delay` accordingly.
versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md:113
- Remove the apostrophe in '10's'; use '10s' for seconds.
Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10's to get started, you can change the `delay` accordingly.
vale_styles/config/vocabularies/Base/accept.txt:115
- Correct the spelling 'subequent' to 'subsequent'.
subequent
| @@ -99,7 +99,7 @@ As code evolves, test cases must be updated, requiring ongoing coordination with | |||
| | Skill Level | Requires specialized technical skills | Can be performed by testers with various skill levels | | |||
| | Types of Defects Found | Internal logic errors, security vulnerabilities | Functional, usability, and performance issues | | |||
|
|
|||
| ## How to perform Whitebox testing with Keploy ? | |||
| ## How to perform White Box testing with Keploy ? | |||
There was a problem hiding this comment.
Remove the space before the question mark ('Keploy?') and ensure consistent capitalization of 'White Box'.
Suggested change
| ## How to perform White Box testing with Keploy ? | |
| ## How to Perform White Box Testing with Keploy? |
Copilot uses AI. Check for mistakes.
| @@ -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.
Alt text should accurately describe the image (e.g., 'TestNG logo') to improve accessibility.
Suggested change
|  | |
|  |
Copilot uses AI. Check for mistakes.
| @@ -51,7 +51,7 @@ This testing approach is essential for several reasons: | |||
| 5. **Detection of Defects**: Identifies functional errors, security vulnerabilities, and performance bottlenecks. | |||
| 6. **Accessibility**: Suitable for testers with diverse backgrounds and skill sets, adaptable to various software applications. | |||
|
|
|||
| ## Whate are types of Black-Box Testing Techniques ? | |||
| ## What are types of Black-Box Testing Techniques ? | |||
There was a problem hiding this comment.
Remove the space before the question mark ('Techniques?') and correct header grammar.
Suggested change
| ## What are types of Black-Box Testing Techniques ? | |
| ## What are the Types of Black-Box Testing Techniques? |
Copilot uses AI. Check for mistakes.
|
Npm build is also successful |
pratik-mahalle
force-pushed
the
lint-issue
branch
from
21fb5ca to
616e6f3
Compare
| > Combine multiple assertions in one step to cover status, headers **and** body in a single round-trip. Every assertion is evaluated independently, so one failure pinpoints the exact mismatch. | ||
|
|
||
| ## Edit and Manage Test Suites | ||
| ## Edit or Delete a Test Suite |
There was a problem hiding this comment.
Don't change the sentences from the original docs
| @@ -33,8 +33,8 @@ Install the extension, hit **Record API Calls**, exercise your web app, then pre | |||
| 2. Click **Record API Calls**. | |||
| 3. In another tab, **exercise your app** as a normal user (create an account, add to cart, etc.). | |||
| 4. Watch the live counters: | |||
| - **Captured calls** – total XHR/fetch requests intercepted. | |||
| - **Complete req/resp** – pairs where both request _and_ response were fully captured. | |||
| - **Captured calls**—total XHR/fetch requests intercepted. | |||
There was a problem hiding this comment.
is the space actually causing an issue??. I could see this one in every files. Have verified without spaces??
There was a problem hiding this comment.
Yeas, we need to add the spaces before and after the dash
There was a problem hiding this comment.
It will count it as a error
| @@ -12,14 +12,14 @@ You accept and agree to the following terms and conditions for Your present and | |||
|
|
|||
| 2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. | |||
|
|
|||
| 3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. | |||
| 3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contributions alone or by combination of Your Contributions with the Work to which such Contributions was submitted. | |||
There was a problem hiding this comment.
I don't think so the word Contribution(s) is wrong, people actually use this syntax in the legal documents like licenses
There was a problem hiding this comment.
Yes It is not wrong, but as per the vale rules, we can write it like this, it throws an error if we write like this
There was a problem hiding this comment.
Yeah, I check it before also. Same suggestion it was giving to remove the bracket (s)
|
Please fix the DCO and conflicts issues @pratik-mahalle |
Signed-off-by: pratik-mahalle <[email protected]>
Signed-off-by: pratik-mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: pratik-mahalle <[email protected]>
Signed-off-by: pratik-mahalle <[email protected]>
pratik-mahalle
force-pushed
the
lint-issue
branch
from
a809dd5 to
a24c3f1
Compare
|
Hey @Achanandhi-M, I have signed the dco and also did the rebase. Please check it! |
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