Skip to content

Conversation

@CBID2
Copy link
Contributor

@CBID2 CBID2 commented Oct 27, 2025

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
    This PR introduces a new documentation quality check using Vale, a powerful linter for prose. This is a redo of the original PR feat: add Vale linter configuration and GitHub Action workflow #2102, which initially set up Vale via GitHub Actions but some configuration adjustments prevented me from continuing with that version.

  • Why was this change needed? (You can also link to an open issue here)

    • Ensures consistent spelling and style across documentation
    • Catches common writing issues before they're merged
    • Reduces the need for manual proofreading of documentation changes
    • Complements the existing documentation standards with automated checks
  • Other information:

    • Added a comprehensive custom dictionary for DocsGPT-specific terms
    • Configured to ignore common false positives (code blocks, paths, etc.)
    • Set up to run on all Markdown files in the docs directory
    • Includes a GitHub Actions workflow for automated checks on PRs

    Closes 🚀 Feature: add vale Linter for documentation maintenance  #2099

@vercel
Copy link

vercel bot commented Oct 27, 2025

@CBID2 is attempting to deploy a commit to the Arc53 Team on Vercel.

A member of the Team first needs to authorize it.

@codecov
Copy link

codecov bot commented Oct 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 43.66%. Comparing base (9b2383b) to head (d814742).
⚠️ Report is 19 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2104      +/-   ##
==========================================
+ Coverage   42.28%   43.66%   +1.37%     
==========================================
  Files         136      140       +4     
  Lines        9315     9860     +545     
==========================================
+ Hits         3939     4305     +366     
- Misses       5376     5555     +179     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Pranavi125

This comment was marked as spam.

@CBID2
Copy link
Contributor Author

CBID2 commented Oct 29, 2025

👋 Hi maintainers! I’d like to work on improving the responsiveness of the search bar as part of Hacktoberfest.

I’ve reviewed the frontend structure (React/Tailwind) and can handle layout and state adjustments.

Could you please assign this issue to me? 😊

Hi @Pranavi125! You've replied to a Pull Request. Not an issue 😁

@dartpain dartpain merged commit 7dd9782 into arc53:main Oct 31, 2025
5 of 7 checks passed
@CBID2 CBID2 deleted the installing-vale branch October 31, 2025 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github Github workflows repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🚀 Feature: add vale Linter for documentation maintenance

3 participants