chore(docs): add Vale grammar/style checker in CI
Adds a GitHub Actions workflow that runs Vale (https://vale.sh) to check grammar and style on Markdown documentation.
- Downloads official Errata styles (https://github.com/errata-ai/styles).
- Runs automatically on pull requests touching .md files or docs.
This helps keep Plane’s documentation consistent and grammatically correct.
Summary by CodeRabbit
- Chores
- Established automated documentation linting workflow to validate Markdown files for style and quality consistency. The workflow runs on all pull requests that modify documentation, Markdown files, or workflow configurations, leveraging Microsoft and Technical style guidelines to maintain documentation standards.
@tapchan54 is attempting to deploy a commit to the Marketing at Plane Team on Vercel.
A member of the Team first needs to authorize it.
Walkthrough
This PR introduces Vale documentation linting configuration. It adds a GitHub Actions workflow that automatically runs Vale on pull requests affecting Markdown or documentation files, along with a configuration file specifying linting rules and style paths for Markdown documents.
Changes
| Cohort / File(s) | Summary |
|---|---|
Vale Documentation Linting Setup \.github/workflows/vale\.yml, \.vale\.ini |
Adds GitHub Actions workflow to run Vale linting on PRs, triggered by changes to Markdown, docs, or workflow files. Clones errata-ai/styles repository and runs vale-action@v2. Includes configuration file specifying StylesPath, MinAlertLevel set to suggestion, and Microsoft and Technical styles for Markdown files. |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~3 minutes
- Both files are straightforward configuration additions with no complex logic or interdependencies to verify
- Workflow file follows standard GitHub Actions patterns
- INI configuration is minimal with basic key-value settings
Poem
🐰 A Vale so true, we now proclaim, To lint our docs with careful aim, GitHub Actions guards each PR, Markdown shines, no errors bar! Styles aligned, suggestions clear— Perfection blooms when linting's here! ✨
Pre-merge checks and finishing touches
❌ Failed checks (1 warning)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage | ⚠️ Warning | Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. | You can run @coderabbitai generate docstrings to improve docstring coverage. |
✅ Passed checks (2 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title Check | ✅ Passed | The pull request title "chore(docs): add Vale grammar/style checker in CI" accurately describes the main objective of the changeset. The two modified files directly implement this objective: .github/workflows/vale.yml establishes the GitHub Actions workflow to run Vale linting, and .vale.ini configures Vale's behavior for Markdown files. The title is concise, specific, and clearly communicates to reviewers that the PR adds automated grammar and style checking to the continuous integration pipeline. It follows conventional commit practices with an appropriate "chore(docs)" scope. |
✨ Finishing touches
🧪 Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
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.
Comment @coderabbitai help to get the list of available commands and usage tips.