Documentation Quality

feat: add Result Callback guide #157

Sign in to view logs

Triggered via pull request September 15, 2025 08:55

Le-Caignec

synchronize #67

feature/result-callback

Status Success

Total duration 17s

Artifacts –

vale.yml

on: pull_request

Vale Documentation Quality Check

Annotations

2 errors, 5 warnings, and 5 notices

[vale] src/guides/build-iapp/advanced/result-callback.md#L23: src/guides/build-iapp/advanced/result-callback.md#L23

[Vale.Spelling] Did you really mean 'calldata'?

[vale] src/guides/build-iapp/advanced/result-callback.md#L31: src/guides/build-iapp/advanced/result-callback.md#L31

[Vale.Terms] Use 'json' instead of 'JSON'.

[vale] src/guides/build-iapp/advanced/result-callback.md#L6: src/guides/build-iapp/advanced/result-callback.md#L6

[Google.Headings] 'Result Callback' should use sentence-style capitalization.

[vale] src/guides/build-iapp/advanced/result-callback.md#L11: src/guides/build-iapp/advanced/result-callback.md#L11

[Google.Headings] 'When to Use a Callback' should use sentence-style capitalization.

[vale] src/guides/build-iapp/advanced/result-callback.md#L27: src/guides/build-iapp/advanced/result-callback.md#L27

[Google.Headings] 'Step-by-Step Implementation' should use sentence-style capitalization.

[vale] src/guides/build-iapp/advanced/result-callback.md#L61: src/guides/build-iapp/advanced/result-callback.md#L61

[Google.Headings] 'Step 2: Deploy the Callback Contract' should use sentence-style capitalization.

[vale] src/guides/build-iapp/advanced/result-callback.md#L89: src/guides/build-iapp/advanced/result-callback.md#L89

[Google.Will] Avoid using 'will'.

[vale] src/guides/build-iapp/advanced/result-callback.md#L16: src/guides/build-iapp/advanced/result-callback.md#L16

[Google.Parens] Use parentheses judiciously.

[vale] src/guides/build-iapp/advanced/result-callback.md#L17: src/guides/build-iapp/advanced/result-callback.md#L17

[Google.Parens] Use parentheses judiciously.

[vale] src/guides/build-iapp/advanced/result-callback.md#L25: src/guides/build-iapp/advanced/result-callback.md#L25

[Google.Parens] Use parentheses judiciously.

[vale] src/guides/build-iapp/advanced/result-callback.md#L89: src/guides/build-iapp/advanced/result-callback.md#L89

[Google.Passive] In general, use active voice instead of passive voice ('is completed').

[vale] src/guides/build-iapp/advanced/result-callback.md#L100: src/guides/build-iapp/advanced/result-callback.md#L100

[Google.Parens] Use parentheses judiciously.