docs: MkDocs Material site — review-ready v1 (Diátaxis, tutorial, how-tos, CI gates) #350
ci.yml
on: pull_request
Lint
30s
Docs (build + examples + prose)
48s
S3 Offload Tests (LocalStack)
1m 35s
Matrix: test
Annotations
12 errors, 1 warning, and 1 notice
|
Lint
Process completed with exit code 1.
|
|
Docs (build + examples + prose)
Process completed with exit code 2.
|
|
Docs (build + examples + prose)
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
|
|
Docs (build + examples + prose):
docs/concepts/index.md#L35
[vale] reported by reviewdog 🐶
[Google.EmDash] Don't put a space before or after a dash.
Raw Output:
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/concepts/index.md", "range": {"start": {"line": 35, "column": 20}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/concepts/index.md#L22
[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'subprocess' instead of 'Subprocess'.
Raw Output:
{"message": "[Vale.Terms] Use 'subprocess' instead of 'Subprocess'.", "location": {"path": "docs/concepts/index.md", "range": {"start": {"line": 22, "column": 5}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/concepts/index.md#L13
[vale] reported by reviewdog 🐶
[Google.EmDash] Don't put a space before or after a dash.
Raw Output:
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/concepts/index.md", "range": {"start": {"line": 13, "column": 36}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/concepts/index.md#L13
[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vgi' instead of 'VGI'.
Raw Output:
{"message": "[Vale.Terms] Use 'vgi' instead of 'VGI'.", "location": {"path": "docs/concepts/index.md", "range": {"start": {"line": 13, "column": 3}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/concepts/index.md#L7
[vale] reported by reviewdog 🐶
[Google.EmDash] Don't put a space before or after a dash.
Raw Output:
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/concepts/index.md", "range": {"start": {"line": 7, "column": 46}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/concepts/index.md#L7
[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vgi' instead of 'VGI'.
Raw Output:
{"message": "[Vale.Terms] Use 'vgi' instead of 'VGI'.", "location": {"path": "docs/concepts/index.md", "range": {"start": {"line": 7, "column": 43}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/concepts/index.md#L2
[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vgi' instead of 'VGI'.
Raw Output:
{"message": "[Vale.Terms] Use 'vgi' instead of 'VGI'.", "location": {"path": "docs/concepts/index.md", "range": {"start": {"line": 2, "column": 19}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/contributing-docs.md#L33
[vale] reported by reviewdog 🐶
[Google.EmDash] Don't put a space before or after a dash.
Raw Output:
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "docs/contributing-docs.md", "range": {"start": {"line": 33, "column": 50}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose):
docs/contributing-docs.md#L28
[vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g.'.
Raw Output:
{"message": "[Google.Latin] Use 'for example' instead of 'e.g.'.", "location": {"path": "docs/contributing-docs.md", "range": {"start": {"line": 28, "column": 77}}}, "severity": "ERROR"}
|
|
Docs (build + examples + prose)
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: errata-ai/vale-action@v2. Actions will be forced to run with Node.js 24 by default starting June 16th, 2026. Node.js 20 will be removed from the runner on September 16th, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
|
|
Docs (build + examples + prose)
Summary report available at: https://github.com/Query-farm/vgi-python/actions/runs/27577355959#summary-81529040629
|