feat: docs update #23
language-checker.yml
on: pull_request
Language check
34s
Annotations
1 error and 12 warnings
Language check
reviewdog: Too many results (annotations) in diff.
You may miss some annotations due to GitHub limitation for annotation created by logging command.
Please check GitHub Actions log console to see all results.
Limitation:
- 10 warning annotations and 10 error annotations per step
- 50 annotations per job (sum of annotations from all the steps)
- 50 annotations per run (separate from the job annotations, these annotations aren't created by users)
Source: https://github.community/t5/GitHub-Actions/Maximum-number-of-annotations-that-can-be-created-using-GitHub/m-p/39085
|
Language check
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
|
Language check
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
|
Language check:
docs/contribution_guideline.md#L1
[LanguageTool] reported by reviewdog 🐶
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: `ID`
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
Raw Output:
docs/contribution_guideline.md:1:4: This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: `ID`
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
|
Language check:
docs/contribution_guideline.md#L12
[LanguageTool] reported by reviewdog 🐶
It seems that an article is missing. Did you mean “the couple of” or “a couple of”? (BUNCH_OF[2])
Suggestions: `the couple of`, `a couple of`
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=2
Category: GRAMMAR
Raw Output:
docs/contribution_guideline.md:12:2: It seems that an article is missing. Did you mean “the couple of” or “a couple of”? (BUNCH_OF[2])
Suggestions: `the couple of`, `a couple of`
Rule: https://community.languagetool.org/rule/show/BUNCH_OF?lang=en-US&subId=2
Category: GRAMMAR
|
Language check:
docs/contribution_guideline.md#L17
[LanguageTool] reported by reviewdog 🐶
The official spelling of this programming framework is “Vue.js”. (NODE_JS[3])
Suggestions: `Vue.js`
Rule: https://community.languagetool.org/rule/show/NODE_JS?lang=en-US&subId=3
Category: COMPOUNDING
Raw Output:
docs/contribution_guideline.md:17:49: The official spelling of this programming framework is “Vue.js”. (NODE_JS[3])
Suggestions: `Vue.js`
Rule: https://community.languagetool.org/rule/show/NODE_JS?lang=en-US&subId=3
Category: COMPOUNDING
|
Language check:
docs/contribution_guideline.md#L29
[LanguageTool] reported by reviewdog 🐶
The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
Raw Output:
docs/contribution_guideline.md:29:7: The official name of this software platform is spelled with a capital “H”. (GITHUB[1])
Suggestions: `GitHub`
URL: https://en.wikipedia.org/wiki/GitHub
Rule: https://community.languagetool.org/rule/show/GITHUB?lang=en-US&subId=1
Category: CASING
|
Language check:
docs/contribution_guideline.md#L30
[LanguageTool] reported by reviewdog 🐶
This word is normally spelled with a hyphen. (EN_COMPOUNDS_BEGINNER_FRIENDLY)
Suggestions: `beginner-friendly`
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_BEGINNER_FRIENDLY?lang=en-US
Category: MISC
Raw Output:
docs/contribution_guideline.md:30:15: This word is normally spelled with a hyphen. (EN_COMPOUNDS_BEGINNER_FRIENDLY)
Suggestions: `beginner-friendly`
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_BEGINNER_FRIENDLY?lang=en-US
Category: MISC
|
Language check:
docs/dashboard/application_details/persistent_volumes.md#L15
[LanguageTool] reported by reviewdog 🐶
The singular determiner ‘this’ may not agree with the plural noun ‘docs’. Did you mean “these”? (THIS_NNS[2])
Suggestions: `these`
Rule: https://community.languagetool.org/rule/show/THIS_NNS?lang=en-US&subId=2
Category: GRAMMAR
Raw Output:
docs/dashboard/application_details/persistent_volumes.md:15:173: The singular determiner ‘this’ may not agree with the plural noun ‘docs’. Did you mean “these”? (THIS_NNS[2])
Suggestions: `these`
Rule: https://community.languagetool.org/rule/show/THIS_NNS?lang=en-US&subId=2
Category: GRAMMAR
|
Language check:
docs/dashboard/domains.md#L27
[LanguageTool] reported by reviewdog 🐶
It appears that the past participle should be used here. (HAVE_PART_AGREEMENT[1])
Suggestions: ``
URL: https://languagetool.org/insights/post/to-have-grammar/
Rule: https://community.languagetool.org/rule/show/HAVE_PART_AGREEMENT?lang=en-US&subId=1
Category: GRAMMAR
Raw Output:
docs/dashboard/domains.md:27:8: It appears that the past participle should be used here. (HAVE_PART_AGREEMENT[1])
Suggestions: ``
URL: https://languagetool.org/insights/post/to-have-grammar/
Rule: https://community.languagetool.org/rule/show/HAVE_PART_AGREEMENT?lang=en-US&subId=1
Category: GRAMMAR
|
Language check:
docs/dashboard/domains.md#L27
[LanguageTool] reported by reviewdog 🐶
Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Suggestions: `an`
URL: https://languagetool.org/insights/post/indefinite-articles/
Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
Category: MISC
Raw Output:
docs/dashboard/domains.md:27:49: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Suggestions: `an`
URL: https://languagetool.org/insights/post/indefinite-articles/
Rule: https://community.languagetool.org/rule/show/EN_A_VS_AN?lang=en-US
Category: MISC
|
Language check:
docs/dashboard/domains.md#L30
[LanguageTool] reported by reviewdog 🐶
This word is normally spelled with a hyphen. (EN_COMPOUNDS_AUTO_RENEWAL)
Suggestions: `auto-renewal`
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_AUTO_RENEWAL?lang=en-US
Category: MISC
Raw Output:
docs/dashboard/domains.md:30:25: This word is normally spelled with a hyphen. (EN_COMPOUNDS_AUTO_RENEWAL)
Suggestions: `auto-renewal`
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_AUTO_RENEWAL?lang=en-US
Category: MISC
|
Language check:
docs/dashboard/domains.md#L30
[LanguageTool] reported by reviewdog 🐶
This word is normally spelled with a hyphen. (EN_COMPOUNDS_AUTO_RENEWAL)
Suggestions: `auto-renewal`
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_AUTO_RENEWAL?lang=en-US
Category: MISC
Raw Output:
docs/dashboard/domains.md:30:182: This word is normally spelled with a hyphen. (EN_COMPOUNDS_AUTO_RENEWAL)
Suggestions: `auto-renewal`
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_AUTO_RENEWAL?lang=en-US
Category: MISC
|