docs(readme): simplify the readme and example make #779
StaticRocketAnnotations
6 warnings
|
vale:
README.md#L61
[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'AEN') on first occurrence if they're likely to be unfamiliar.
Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'AEN') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "README.md", "range": {"start": {"line": 61, "column": 38}}}, "severity": "INFO"}
|
|
vale:
README.md#L60
[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'AHP') on first occurrence if they're likely to be unfamiliar.
Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'AHP') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "README.md", "range": {"start": {"line": 60, "column": 39}}}, "severity": "INFO"}
|
|
vale:
README.md#L59
[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'AEP') on first occurrence if they're likely to be unfamiliar.
Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'AEP') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "README.md", "range": {"start": {"line": 59, "column": 39}}}, "severity": "INFO"}
|
|
vale:
README.md#L58
[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'VCL') on first occurrence if they're likely to be unfamiliar.
Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'VCL') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "README.md", "range": {"start": {"line": 58, "column": 38}}}, "severity": "INFO"}
|
|
vale:
README.md#L1
[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Processor software development kit documentation'.
Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Processor software development kit documentation'.", "location": {"path": "README.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "INFO"}
|
|
vale:
README.md#L1
[vale] reported by reviewdog 🐶
[RedHat.ReadabilityGrade] Simplify your language. The calculated Flesch–Kincaid grade level of 10.29 is above the recommended reading grade level of 9.
Raw Output:
{"message": "[RedHat.ReadabilityGrade] Simplify your language. The calculated Flesch–Kincaid grade level of 10.29 is above the recommended reading grade level of 9.", "location": {"path": "README.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}
|