docs(doc): Add vale doc linter as a GitHub workflow.
Submit a pull request
🎯 Goal
Adds Vale doc linter to the GitHub workflow. This uses the Google defined documentation config making sure the documentation of the SDK will gradually be clear of easy to miss spelling errors and other typical small issues.
🛠 Implementation details
Uses Vale.sh with it's associated GH Action. More info on the tool can be read on mentioned URL.
🎨 UI Changes
No UI changes to the SDK. Just a feedback mechanism on pull request on markdown files that are actually touched in a pull request.
Codecov Report
Base: 83.46% // Head: 83.51% // Increases project coverage by +0.04% :tada:
Coverage data is based on head (
1bc54a6) compared to base (0441789). Patch has no changes to coverable lines.
:exclamation: Current head 1bc54a6 differs from pull request most recent head 65b2d88. Consider uploading reports for the commit 65b2d88 to get more accurate results
Additional details and impacted files
@@ Coverage Diff @@
## develop #1859 +/- ##
===========================================
+ Coverage 83.46% 83.51% +0.04%
===========================================
Files 259 259
Lines 6410 6404 -6
Branches 1806 1798 -8
===========================================
- Hits 5350 5348 -2
+ Misses 891 889 -2
+ Partials 169 167 -2
| Impacted Files | Coverage Δ | |
|---|---|---|
| src/utils.tsx | 79.10% <0.00%> (-0.16%) |
:arrow_down: |
| src/components/Channel/Channel.tsx | 81.02% <0.00%> (+0.64%) |
:arrow_up: |
| ...rc/components/MessageInput/hooks/useUserTrigger.ts | 72.46% <0.00%> (+1.03%) |
:arrow_up: |
| ...components/MessageInput/hooks/useCooldownTimer.tsx | 83.33% <0.00%> (+1.51%) |
:arrow_up: |
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.
:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.