Skip to content

docs: fix vale linting errors #586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

pratik-mahalle
Copy link

📝 PR Description

🎯 Summary

Fixes Vale linting errors across Keploy documentation, reducing errors.

This pull request addresses the issues with failing Vale Doc Linter and Prettier pipelines as described in Issue #2696.

  • Fixed numerous spelling and style errors flagged by Vale across the documentation files.
  • Corrected branch/tag references in the Prettier pipeline configuration.

Type of change

  • Bug fix (non-breaking change which fixes an issue).

Signed-off-by: Pratik Mahalle <[email protected]>
@Copilot Copilot AI review requested due to automatic review settings June 23, 2025 05:45
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses Vale linting and style issues across the documentation, fixing spelling, grammar, and formatting inconsistencies.

  • Corrected spelling and punctuation errors in multiple docs.
  • Updated code example in Go supported-frameworks to use WithContext and Find.
  • Harmonized style guidelines and fixed punctuation in style reference.

Reviewed Changes

Copilot reviewed 18 out of 50 changed files in this pull request and generated no comments.

File Description
versioned_docs/version-2.0.0/concepts Fixed typos (e.g., “accelrating” → “accelerating”)
versioned_docs/version-1.0.0/go/supported-frameworks.md Replaced PingContext/ExecContext example with WithContext & Find
STYLE.md Updated quotations and dash style, unified punctuation
Comments suppressed due to low confidence (4)

STYLE.md:63

  • The guideline refers to en dashes but shows an em dash; use the correct en dash character (–) instead of an em dash (—) to match the description.
Use **en dashes (—)** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently.  

versioned_docs/version-1.0.0/operation/browser-extension.md:58

  • [nitpick] Per sentence-case guidelines, consider using lowercase 'first' ("your first test case") since it's not a proper noun.
**Step-2**: Give a title to your First test case

versioned_docs/version-1.0.0/go/supported-frameworks.md:351

  • Consider checking and handling errors from subsequent DB operations (like Find) to avoid silent failures.
            pSQL_DB = pSQL_DB.WithContext(c.Request.Context())

versioned_docs/version-1.0.0/go/supported-frameworks.md:356

  • The variable x is declared but not used. Consider renaming it to something descriptive or handling the result/error explicitly.
            x := pSQL_DB.Find(&people)

pratik-mahalle and others added 5 commits June 23, 2025 12:06
@pratik-mahalle
Copy link
Author

@Achanandhi-M , Can you review this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant