Add vale linter to check for errors in text

[Aviatorscode2]

Summary by CodeRabbit

• Chores
  • Added configuration for documentation quality standards with multiple style packages
  • Updated project ignore rules to exclude generated directories

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[netlify]

✅ Deploy Preview for docs-novu ready!

Name	Link
🔨 Latest commit	ae0cba1
🔍 Latest deploy log	https://app.netlify.com/projects/docs-novu/deploys/6932c95861ba9700080d04fa
😎 Deploy Preview	https://deploy-preview-1018--docs-novu.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Walkthrough

Introduces Vale writing configuration to the repository by creating a .vale.ini configuration file with style packages (Google and write-good), alert levels, and format mappings, while excluding the .vale/styles directory from version control via .gitignore.

Changes

Cohort / File(s)	Summary
Vale writing linter setup \.gitignore, \.vale\.ini	Added .vale/styles to gitignore; introduced new .vale.ini configuration file with StylesPath, MinAlertLevel, package definitions (Google, write-good), and scope rules for Markdown and MDX files

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify .vale.ini configuration syntax and that the style packages (Google, write-good) are appropriate for the project
• Confirm .vale/styles directory path in gitignore matches the StylesPath in .vale.ini
• Check that the format mapping and scope rules align with the repository's documentation standards

Poem

🐰 A rabbit hops through words so fine,
With Vale's good taste and style divine,
Google rules and write-good cheer,
Now prose stays crisp and ever clear! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add vale linter to check for errors in text' accurately summarizes the main changes: adding Vale configuration (.vale.ini) and gitignore entry for Vale styles.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch vale-linter

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.vale.ini (1)

1-19: Consider adding exclusion patterns to avoid false positives.

The current configuration applies Vale rules broadly to all .md and .mdx files without exclusion patterns. Consider adding IgnoredScopes or other exclusion rules to prevent linting tool outputs, code blocks, configuration examples, or other non-prose content that might trigger false positives.

For example:

 [*.{md,mdx}]
 BasedOnStyles = Google, Novu, write-good
+IgnoredScopes = code, code_block

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55cf1fc and ae0cba1.

📒 Files selected for processing (2)

• .gitignore (1 hunks)
• .vale.ini (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: Redirect rules - docs-novu
• GitHub Check: Header rules - docs-novu
• GitHub Check: Pages changed - docs-novu
• GitHub Check: Build and Lint

🔇 Additional comments (2)

.vale.ini (1)

18-19: Verify that the "Novu" style guide is available.

The configuration references a "Novu" style guide alongside standard Vale packages (Google and write-good). Confirm that this custom style guide exists, is properly installed, or will be downloaded when Vale runs. If it's a project-specific style, consider documenting where/how it's obtained.

.gitignore (1)

32-33: LGTM!

Good practice to exclude .vale/styles from version control, as this directory will contain downloaded style packages. Consistent with how other generated/downloaded artifacts are handled in the repository.

[jainpawan21]

@Aviatorscode2

Could you please share the link of Novu? I could not find here
https://vale.sh/explorer

[Aviatorscode2]

@jainpawan21, All rules are local for now. I am using Google and write-good rules for now to catch any errors before I commit them. So I need it merged. For now what I need is Google and write-good, while I work on the Novu style guide rules