Documentation Quality

refactor: iapp references #75

Sign in to view logs

Triggered via pull request August 22, 2025 08:39

Le-Caignec

synchronize #48

refactor/iapp-references

Status Success

Total duration 19s

Artifacts –

vale.yml

on: pull_request

Vale Documentation Quality Check

Annotations

37 errors, 31 warnings, and 31 notices

[vale] src/get-started/protocol/tee/introduction.md#L122: src/get-started/protocol/tee/introduction.md#L122

[Vale.Terms] Use 'intel' instead of 'Intel'.

[vale] src/get-started/protocol/tee/intel-tdx.md#L140: src/get-started/protocol/tee/intel-tdx.md#L140

[Vale.Terms] Use 'intel' instead of 'Intel'.

[vale] src/get-started/protocol/tee/sgx-vs-tdx.md#L82: src/get-started/protocol/tee/sgx-vs-tdx.md#L82

[Vale.Terms] Use 'intel' instead of 'Intel'.

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

[Vale.Terms] Use 'intel' instead of 'Intel'.

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

[Vale.Terms] Use 'intel' instead of 'Intel'.

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

[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.

[vale] src/references/dataProtector/types.md#L125: src/references/dataProtector/types.md#L125

[Vale.Terms] Use 'iExec' instead of 'iexec'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L131: src/references/iapp-generator/building-your-iexec-app.md#L131

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L132: src/references/iapp-generator/building-your-iexec-app.md#L132

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L133: src/references/iapp-generator/building-your-iexec-app.md#L133

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L135: src/references/iapp-generator/building-your-iexec-app.md#L135

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L137: src/references/iapp-generator/building-your-iexec-app.md#L137

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L146: src/references/iapp-generator/building-your-iexec-app.md#L146

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L146: src/references/iapp-generator/building-your-iexec-app.md#L146

[Google.Latin] Use 'for example' instead of 'e.g.'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L155: src/references/iapp-generator/building-your-iexec-app.md#L155

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L159: src/references/iapp-generator/building-your-iexec-app.md#L159

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L160: src/references/iapp-generator/building-your-iexec-app.md#L160

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L162: src/references/iapp-generator/building-your-iexec-app.md#L162

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L164: src/references/iapp-generator/building-your-iexec-app.md#L164

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L166: src/references/iapp-generator/building-your-iexec-app.md#L166

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L166: src/references/iapp-generator/building-your-iexec-app.md#L166

[Google.Latin] Use 'for example' instead of 'e.g.'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L175: src/references/iapp-generator/building-your-iexec-app.md#L175

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L179: src/references/iapp-generator/building-your-iexec-app.md#L179

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L179: src/references/iapp-generator/building-your-iexec-app.md#L179

[Google.Latin] Use 'for example' instead of 'e.g.'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L188: src/references/iapp-generator/building-your-iexec-app.md#L188

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L188: src/references/iapp-generator/building-your-iexec-app.md#L188

[Google.Latin] Use 'for example' instead of 'e.g.'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L192: src/references/iapp-generator/building-your-iexec-app.md#L192

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L193: src/references/iapp-generator/building-your-iexec-app.md#L193

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L194: src/references/iapp-generator/building-your-iexec-app.md#L194

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L195: src/references/iapp-generator/building-your-iexec-app.md#L195

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L203: src/references/iapp-generator/building-your-iexec-app.md#L203

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L203: src/references/iapp-generator/building-your-iexec-app.md#L203

[Google.Latin] Use 'for example' instead of 'e.g.'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L207: src/references/iapp-generator/building-your-iexec-app.md#L207

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L207: src/references/iapp-generator/building-your-iexec-app.md#L207

[Google.Latin] Use 'for example' instead of 'e.g.'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L209: src/references/iapp-generator/building-your-iexec-app.md#L209

[Google.EmDash] Don't put a space before or after a dash.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L215: src/references/iapp-generator/building-your-iexec-app.md#L215

[Vale.Terms] Use 'intel' instead of 'Intel'.

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

[Vale.Terms] Use 'intel' instead of 'Intel'.

[vale] src/guides/build-iapp/advanced/access-confidential-assets.md#L14: src/guides/build-iapp/advanced/access-confidential-assets.md#L14

[Google.WordList] Use 'app' instead of 'application'.

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

[Google.Headings] 'Run the TEE iApp' should use sentence-style capitalization.

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

[Google.WordList] Use 'to' instead of 'in order to'.

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

[Google.Will] Avoid using 'will'.

[vale] src/guides/build-iapp/advanced/protect-the-result.md#L20: src/guides/build-iapp/advanced/protect-the-result.md#L20

[Google.WordList] Use 'app' instead of 'application'.

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

[Google.We] Try to avoid using first-person plural like 'we'.

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

[Google.Will] Avoid using 'will'.

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

[Google.WordList] Use 'app' instead of 'application'.

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

[Google.We] Try to avoid using first-person plural like 'we'.

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

[Google.Will] Avoid using 'will'.

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

[Google.WordList] Use 'app' instead of 'application'.

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

[Google.Will] Avoid using 'will'.

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

[Google.WordList] Use 'app' instead of 'application'.

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

[Google.WordList] Use 'app' instead of 'application'.

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

[Google.Will] Avoid using 'will'.

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

[Google.Will] Avoid using 'will'.

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

[Google.WordList] Use 'app' instead of 'application'.

[vale] src/guides/build-iapp/advanced/quick-start.md#L351: src/guides/build-iapp/advanced/quick-start.md#L351

[Google.WordList] Use 'app' instead of 'application'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L116: src/references/iapp-generator/building-your-iexec-app.md#L116

[Google.WordList] Use 'command-line tool' instead of 'CLI'.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L120: src/references/iapp-generator/building-your-iexec-app.md#L120

[Google.Colons] ': I' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L122: src/references/iapp-generator/building-your-iexec-app.md#L122

[Google.Colons] ': C' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L127: src/references/iapp-generator/building-your-iexec-app.md#L127

[Google.Colons] ': T' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L142: src/references/iapp-generator/building-your-iexec-app.md#L142

[Google.Colons] ': D' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L151: src/references/iapp-generator/building-your-iexec-app.md#L151

[Google.Colons] ': E' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L171: src/references/iapp-generator/building-your-iexec-app.md#L171

[Google.Colons] ': R' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L184: src/references/iapp-generator/building-your-iexec-app.md#L184

[Google.Colons] ': C' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L199: src/references/iapp-generator/building-your-iexec-app.md#L199

[Google.Colons] ': M' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L211: src/references/iapp-generator/building-your-iexec-app.md#L211

[Google.Headings] 'Advanced Options' should use sentence-style capitalization.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L215: src/references/iapp-generator/building-your-iexec-app.md#L215

[Google.Colons] ': E' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L216: src/references/iapp-generator/building-your-iexec-app.md#L216

[Google.Colons] ': S' should be in lowercase.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L242: src/references/iapp-generator/building-your-iexec-app.md#L242

[Google.WordList] Use 'app' instead of 'application'.

[vale] src/get-started/protocol/tee/introduction.md#L122: src/get-started/protocol/tee/introduction.md#L122

[Google.Parens] Use parentheses judiciously.

[vale] src/get-started/protocol/tee/intel-tdx.md#L140: src/get-started/protocol/tee/intel-tdx.md#L140

[Google.Parens] Use parentheses judiciously.

[vale] src/get-started/protocol/tee/sgx-vs-tdx.md#L82: src/get-started/protocol/tee/sgx-vs-tdx.md#L82

[Google.Parens] Use parentheses judiciously.

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

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

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

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

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

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

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

[Google.Contractions] Use 'what's' instead of 'what is'.

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

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

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

[Google.Parens] Use parentheses judiciously.

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

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

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

[Google.Parens] Use parentheses judiciously.

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

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

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

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

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

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

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

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

[vale] src/references/dataProtector/types.md#L125: src/references/dataProtector/types.md#L125

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L132: src/references/iapp-generator/building-your-iexec-app.md#L132

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L135: src/references/iapp-generator/building-your-iexec-app.md#L135

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L146: src/references/iapp-generator/building-your-iexec-app.md#L146

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L159: src/references/iapp-generator/building-your-iexec-app.md#L159

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L162: src/references/iapp-generator/building-your-iexec-app.md#L162

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L167: src/references/iapp-generator/building-your-iexec-app.md#L167

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L180: src/references/iapp-generator/building-your-iexec-app.md#L180

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L188: src/references/iapp-generator/building-your-iexec-app.md#L188

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L203: src/references/iapp-generator/building-your-iexec-app.md#L203

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L209: src/references/iapp-generator/building-your-iexec-app.md#L209

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L209: src/references/iapp-generator/building-your-iexec-app.md#L209

[Google.Parens] Use parentheses judiciously.

[vale] src/references/iapp-generator/building-your-iexec-app.md#L217: src/references/iapp-generator/building-your-iexec-app.md#L217

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

[vale] src/references/iapp-generator/building-your-iexec-app.md#L225: src/references/iapp-generator/building-your-iexec-app.md#L225

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

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

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

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

[Google.Parens] Use parentheses judiciously.