new genai rag guide #14128
Annotations
10 errors and 10 warnings
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L14
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'walks'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'walks'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 14, "column": 12}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L14
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'integrates'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'integrates'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 14, "column": 66}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L14
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'systems'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'systems'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 14, "column": 114}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L14
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'databases'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'databases'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 14, "column": 133}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L14
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'this'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'this'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 14, "column": 147}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L16
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'enhances'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'enhances'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 16, "column": 30}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L16
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'models'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'models'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 16, "column": 48}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L16
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'databases'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'databases'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 16, "column": 86}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L17
[vale] reported by reviewdog ๐ถ
[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'databases'.
Raw Output:
{"message": "[Vale.Terms] Use '(?-i)[A-Z]{2,}'?s' instead of 'databases'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 17, "column": 83}}}, "severity": "ERROR"}
|
Run errata-ai/vale-action@reviewdog
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
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L34
[vale] reported by reviewdog ๐ถ
[Docker.RecommendedWords] Consider using 'versus' instead of 'vs'
Raw Output:
{"message": "[Docker.RecommendedWords] Consider using 'versus' instead of 'vs'", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 34, "column": 21}}}, "severity": "INFO"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L49
[vale] reported by reviewdog ๐ถ
[Docker.HeadingSentenceCase] Use sentence case for headings: 'Understanding RAG (Retrieval-Augmented Generation)'.
Raw Output:
{"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'Understanding RAG (Retrieval-Augmented Generation)'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 49, "column": 4}}}, "severity": "WARNING"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L85
[vale] reported by reviewdog ๐ถ
[Docker.HeadingSentenceCase] Use sentence case for headings: 'A Case Study in RAG Implementation'.
Raw Output:
{"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'A Case Study in RAG Implementation'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 85, "column": 4}}}, "severity": "WARNING"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L89
[vale] reported by reviewdog ๐ถ
[Docker.We] Avoid using first-person plural like 'our'.
Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'our'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 89, "column": 57}}}, "severity": "WARNING"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L89
[vale] reported by reviewdog ๐ถ
[Docker.We] Avoid using first-person plural like 'us'.
Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'us'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 89, "column": 80}}}, "severity": "WARNING"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L119
[vale] reported by reviewdog ๐ถ
[Docker.HeadingLength] Try to keep headings short (< 8 words).
Raw Output:
{"message": "[Docker.HeadingLength] Try to keep headings short (\u003c 8 words).", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 119, "column": 4}}}, "severity": "INFO"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L136
[vale] reported by reviewdog ๐ถ
[Docker.We] Avoid using first-person plural like 'We'.
Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'We'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 136, "column": 28}}}, "severity": "WARNING"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L165
[vale] reported by reviewdog ๐ถ
[Docker.RecommendedWords] Consider using 'select' instead of 'click'
Raw Output:
{"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 165, "column": 177}}}, "severity": "INFO"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L193
[vale] reported by reviewdog ๐ถ
[Docker.We] Avoid using first-person plural like 'we'.
Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'we'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 193, "column": 6}}}, "severity": "WARNING"}
|
Run errata-ai/vale-action@reviewdog:
content/guides/genai-rag.md#L193
[vale] reported by reviewdog ๐ถ
[Docker.We] Avoid using first-person plural like 'our'.
Raw Output:
{"message": "[Docker.We] Avoid using first-person plural like 'our'.", "location": {"path": "content/guides/genai-rag.md", "range": {"start": {"line": 193, "column": 29}}}, "severity": "WARNING"}
|
Loading