Documentation Quality

Feature/split inputs outputs sections #109

Sign in to view logs

Triggered via pull request August 28, 2025 07:21

aimen-djari

synchronize #59

feature/split-inputs-outputs-sections

Status Success

Total duration 19s

Artifacts –

vale.yml

on: pull_request

Vale Documentation Quality Check

Annotations

1 error, 5 warnings, and 8 notices

[vale] src/guides/build-iapp/outputs.md#L96: src/guides/build-iapp/outputs.md#L96

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

[vale] src/guides/build-iapp/outputs.md#L18: src/guides/build-iapp/outputs.md#L18

[Google.Headings] 'Creating Outputs' should use sentence-style capitalization.

[vale] src/guides/build-iapp/outputs.md#L23: src/guides/build-iapp/outputs.md#L23

[Google.Headings] 'Basic Output Structure' should use sentence-style capitalization.

[vale] src/guides/build-iapp/outputs.md#L91: src/guides/build-iapp/outputs.md#L91

[Google.Headings] 'Output Best Practices' should use sentence-style capitalization.

[vale] src/guides/build-iapp/outputs.md#L102: src/guides/build-iapp/outputs.md#L102

[Google.Headings] 'Example: Multi-file Output' should use sentence-style capitalization.

[vale] src/guides/build-iapp/outputs.md#L136: src/guides/build-iapp/outputs.md#L136

[Google.Headings] 'What's Next?' should use sentence-style capitalization.

[vale] src/guides/build-iapp/debugging.md#L173: src/guides/build-iapp/debugging.md#L173

[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.

[vale] src/guides/build-iapp/outputs.md#L99: src/guides/build-iapp/outputs.md#L99

[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.

[vale] src/guides/build-iapp/outputs.md#L99: src/guides/build-iapp/outputs.md#L99

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

[vale] src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md#L280: src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md#L280

[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.

[vale] src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md#L281: src/guides/build-iapp/advanced/build-your-first-tdx-iapp.md#L281

[Google.Acronyms] Spell out 'TDX', if it's unfamiliar to the audience.

[vale] src/guides/build-iapp/inputs.md#L16: src/guides/build-iapp/inputs.md#L16

[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.

[vale] src/protocol/ai.md#L173: src/protocol/ai.md#L173

[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.

[vale] src/references/iapp-generator.md#L44: src/references/iapp-generator.md#L44

[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.