Skip to content

docs: Update docs tooling and checks #435

docs: Update docs tooling and checks

docs: Update docs tooling and checks #435

GitHub Actions / vale completed Nov 14, 2023 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (9)

docs/guides/migrate-from-swagger-cli.md|30 col 50| [Rules.FutureTense] Avoid using future tense: "won't be". Use present tense instead.
docs/guides/migrate-from-swagger-cli.md|30 col 113| [Rules.FutureTense] Avoid using future tense: "won't be". Use present tense instead.
docs/guides/migrate-from-swagger-cli.md|41 col 13| [Rules.FutureTense] Avoid using future tense: "will automatically". Use present tense instead.
docs/guides/migrate-from-redoc-cli.md|17 col 5| [Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.
docs/guides/migrate-from-redoc-cli.md|25 col 19| [Rules.FutureTense] Avoid using future tense: "will update". Use present tense instead.
docs/guides/migrate-from-redoc-cli.md|34 col 5| [Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.
docs/configuration/rules.md|1 col 3| [Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.
docs/configuration/index.md|81 col 173| [Rules.FutureTense] Avoid using future tense: "will override". Use present tense instead.
docs/changelog.md|28 col 15| [Rules.FutureTense] Avoid using future tense: "will exit". Use present tense instead.

Filtered Findings (0)

Annotations

Check failure on line 30 in docs/guides/migrate-from-swagger-cli.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/guides/migrate-from-swagger-cli.md#L30

[Rules.FutureTense] Avoid using future tense: "won't be". Use present tense instead.
Raw output
{"message": "[Rules.FutureTense] Avoid using future tense: \"won't be\". Use present tense instead.", "location": {"path": "docs/guides/migrate-from-swagger-cli.md", "range": {"start": {"line": 30, "column": 50}}}, "severity": "ERROR"}

Check failure on line 30 in docs/guides/migrate-from-swagger-cli.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/guides/migrate-from-swagger-cli.md#L30

[Rules.FutureTense] Avoid using future tense: "won't be". Use present tense instead.
Raw output
{"message": "[Rules.FutureTense] Avoid using future tense: \"won't be\". Use present tense instead.", "location": {"path": "docs/guides/migrate-from-swagger-cli.md", "range": {"start": {"line": 30, "column": 113}}}, "severity": "ERROR"}

Check failure on line 41 in docs/guides/migrate-from-swagger-cli.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/guides/migrate-from-swagger-cli.md#L41

[Rules.FutureTense] Avoid using future tense: "will automatically". Use present tense instead.
Raw output
{"message": "[Rules.FutureTense] Avoid using future tense: \"will automatically\". Use present tense instead.", "location": {"path": "docs/guides/migrate-from-swagger-cli.md", "range": {"start": {"line": 41, "column": 13}}}, "severity": "ERROR"}

Check failure on line 17 in docs/guides/migrate-from-redoc-cli.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/guides/migrate-from-redoc-cli.md#L17

[Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.
Raw output
{"message": "[Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.", "location": {"path": "docs/guides/migrate-from-redoc-cli.md", "range": {"start": {"line": 17, "column": 5}}}, "severity": "ERROR"}

Check failure on line 25 in docs/guides/migrate-from-redoc-cli.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/guides/migrate-from-redoc-cli.md#L25

[Rules.FutureTense] Avoid using future tense: "will update". Use present tense instead.
Raw output
{"message": "[Rules.FutureTense] Avoid using future tense: \"will update\". Use present tense instead.", "location": {"path": "docs/guides/migrate-from-redoc-cli.md", "range": {"start": {"line": 25, "column": 19}}}, "severity": "ERROR"}

Check failure on line 34 in docs/guides/migrate-from-redoc-cli.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/guides/migrate-from-redoc-cli.md#L34

[Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.
Raw output
{"message": "[Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.", "location": {"path": "docs/guides/migrate-from-redoc-cli.md", "range": {"start": {"line": 34, "column": 5}}}, "severity": "ERROR"}

Check failure on line 1 in docs/configuration/rules.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/configuration/rules.md#L1

[Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.
Raw output
{"message": "[Rules.HeaderGerunds] Do not start headings with with a gerund (ing word). Use an imperative verb instead.", "location": {"path": "docs/configuration/rules.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

Check failure on line 81 in docs/configuration/index.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/configuration/index.md#L81

[Rules.FutureTense] Avoid using future tense: "will override". Use present tense instead.
Raw output
{"message": "[Rules.FutureTense] Avoid using future tense: \"will override\". Use present tense instead.", "location": {"path": "docs/configuration/index.md", "range": {"start": {"line": 81, "column": 173}}}, "severity": "ERROR"}

Check failure on line 28 in docs/changelog.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] docs/changelog.md#L28

[Rules.FutureTense] Avoid using future tense: "will exit". Use present tense instead.
Raw output
{"message": "[Rules.FutureTense] Avoid using future tense: \"will exit\". Use present tense instead.", "location": {"path": "docs/changelog.md", "range": {"start": {"line": 28, "column": 15}}}, "severity": "ERROR"}