Skip to content
Documentation Quality

feat: Refactor iApp, Protected Data, and Workerpool docs #13

Sign in to view logs

feat: Refactor iApp, Protected Data, and Workerpool docs

feat: Refactor iApp, Protected Data, and Workerpool docs #13

Triggered via pull request August 18, 2025 15:02
@Le-CaignecLe-Caignec
synchronize #37
feature/iexec-overview
Status Success
Total duration 22s
Artifacts –

vale.yml

on: pull_request
Vale Documentation Quality Check
18s
Vale Documentation Quality Check
Fit to window
Zoom out
Zoom in

Annotations

11 errors, 43 warnings, and 19 notices
[vale] src/get-started/overview/workerpool.md#L4: src/get-started/overview/workerpool.md#L4
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/workerpool.md#L14: src/get-started/overview/workerpool.md#L14
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/workerpool.md#L14: src/get-started/overview/workerpool.md#L14
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/workerpool.md#L40: src/get-started/overview/workerpool.md#L40
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/workerpool.md#L113: src/get-started/overview/workerpool.md#L113
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/workerpool.md#L140: src/get-started/overview/workerpool.md#L140
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/workerpool.md#L140: src/get-started/overview/workerpool.md#L140
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/workerpool.md#L149: src/get-started/overview/workerpool.md#L149
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/get-started/overview/what-is-iexec.md#L68: src/get-started/overview/what-is-iexec.md#L68
[Vale.Spelling] Did you really mean 'Walkthrough'?
[vale] src/get-started/overview/what-is-iexec.md#L86: src/get-started/overview/what-is-iexec.md#L86
[Vale.Spelling] Did you really mean 'devtools'?
[vale] src/get-started/overview/what-is-iexec.md#L96: src/get-started/overview/what-is-iexec.md#L96
[Vale.Spelling] Did you really mean 'devtools'?
[vale] src/get-started/overview/protected-data.md#L9: src/get-started/overview/protected-data.md#L9
[Google.Headings] 'Protected Data' should use sentence-style capitalization.
[vale] src/get-started/overview/protected-data.md#L21: src/get-started/overview/protected-data.md#L21
[Google.Headings] 'Data Governance' should use sentence-style capitalization.
[vale] src/get-started/overview/protected-data.md#L48: src/get-started/overview/protected-data.md#L48
[Google.Headings] 'Privacy-preserving Computation' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L17: src/get-started/overview/workerpool.md#L17
[Google.Headings] 'Key Concepts' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L19: src/get-started/overview/workerpool.md#L19
[Google.Headings] 'Workerpool Manager' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L28: src/get-started/overview/workerpool.md#L28
[Google.Colons] ': M' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L34: src/get-started/overview/workerpool.md#L34
[Google.Colons] ': D' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L40: src/get-started/overview/workerpool.md#L40
[Google.Colons] ': C' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L46: src/get-started/overview/workerpool.md#L46
[Google.Headings] 'Workers (Computing Machines)' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L55: src/get-started/overview/workerpool.md#L55
[Google.Colons] ': M' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L61: src/get-started/overview/workerpool.md#L61
[Google.Colons] ': R' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L67: src/get-started/overview/workerpool.md#L67
[Google.Colons] ': E' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L73: src/get-started/overview/workerpool.md#L73
[Google.Headings] 'Security & Privacy' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L82: src/get-started/overview/workerpool.md#L82
[Google.Colons] ': A' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L88: src/get-started/overview/workerpool.md#L88
[Google.Colons] ': P' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L94: src/get-started/overview/workerpool.md#L94
[Google.Colons] ': C' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L100: src/get-started/overview/workerpool.md#L100
[Google.Headings] 'How Workerpool Work' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L107: src/get-started/overview/workerpool.md#L107
[Google.Colons] ': U' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L113: src/get-started/overview/workerpool.md#L113
[Google.Colons] ': P' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L119: src/get-started/overview/workerpool.md#L119
[Google.Colons] ': W' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L125: src/get-started/overview/workerpool.md#L125
[Google.Colons] ': W' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L131: src/get-started/overview/workerpool.md#L131
[Google.Colons] ': E' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L137: src/get-started/overview/workerpool.md#L137
[Google.Headings] 'Getting Started' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L140: src/get-started/overview/workerpool.md#L140
[Google.Will] Avoid using 'will'.
[vale] src/get-started/overview/workerpool.md#L143: src/get-started/overview/workerpool.md#L143
[Google.Headings] 'Next Steps' should use sentence-style capitalization.
[vale] src/get-started/overview/workerpool.md#L149: src/get-started/overview/workerpool.md#L149
[Google.Colons] ': B' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L154: src/get-started/overview/workerpool.md#L154
[Google.Colons] ': C' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L154: src/get-started/overview/workerpool.md#L154
[Google.We] Try to avoid using first-person plural like 'us'.
[vale] src/get-started/overview/workerpool.md#L159: src/get-started/overview/workerpool.md#L159
[Google.Colons] ': C' should be in lowercase.
[vale] src/get-started/overview/workerpool.md#L159: src/get-started/overview/workerpool.md#L159
[Google.We] Try to avoid using first-person plural like 'us'.
[vale] src/get-started/overview/what-is-iexec.md#L13: src/get-started/overview/what-is-iexec.md#L13
[Google.Headings] 'The Protocol (Simple Version)' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L15: src/get-started/overview/what-is-iexec.md#L15
[Google.Headings] 'Step 1: Protect Data' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L20: src/get-started/overview/what-is-iexec.md#L20
[Google.Colons] ': D' should be in lowercase.
[vale] src/get-started/overview/what-is-iexec.md#L22: src/get-started/overview/what-is-iexec.md#L22
[Google.Headings] 'Step 2: Secure Computing (Workers)' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L36: src/get-started/overview/what-is-iexec.md#L36
[Google.Headings] 'Step 4: Get Results' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L45: src/get-started/overview/what-is-iexec.md#L45
[Google.Headings] 'What Each Piece Does' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L47: src/get-started/overview/what-is-iexec.md#L47
[Google.Headings] 'Protected Data' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L57: src/get-started/overview/what-is-iexec.md#L57
[Google.Headings] 'Workers (Secure Enclaves)' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L68: src/get-started/overview/what-is-iexec.md#L68
[Google.Headings] 'Real Example Walkthrough' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L78: src/get-started/overview/what-is-iexec.md#L78
[Google.WordList] Use 'email' instead of 'Email'.
[vale] src/get-started/overview/what-is-iexec.md#L82: src/get-started/overview/what-is-iexec.md#L82
[Google.WordList] Use 'email' instead of 'Email'.
[vale] src/get-started/overview/what-is-iexec.md#L84: src/get-started/overview/what-is-iexec.md#L84
[Google.Headings] 'Start Building' should use sentence-style capitalization.
[vale] src/get-started/overview/what-is-iexec.md#L95: src/get-started/overview/what-is-iexec.md#L95
[Google.We] Try to avoid using first-person plural like 'our'.
[vale] src/get-started/overview/workerpool.md#L9: src/get-started/overview/workerpool.md#L9
[Google.Parens] Use parentheses judiciously.
[vale] src/get-started/overview/workerpool.md#L14: src/get-started/overview/workerpool.md#L14
[Google.Parens] Use parentheses judiciously.
[vale] src/get-started/overview/workerpool.md#L14: src/get-started/overview/workerpool.md#L14
[Google.Passive] In general, use active voice instead of passive voice ('are executed').
[vale] src/get-started/overview/workerpool.md#L46: src/get-started/overview/workerpool.md#L46
[Google.Parens] Use parentheses judiciously.
[vale] src/get-started/overview/workerpool.md#L55: src/get-started/overview/workerpool.md#L55
[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.
[vale] src/get-started/overview/workerpool.md#L67: src/get-started/overview/workerpool.md#L67
[Google.Acronyms] Spell out 'RLC', if it's unfamiliar to the audience.
[vale] src/get-started/overview/workerpool.md#L67: src/get-started/overview/workerpool.md#L67
[Google.Acronyms] Spell out 'RLC', if it's unfamiliar to the audience.
[vale] src/get-started/overview/workerpool.md#L82: src/get-started/overview/workerpool.md#L82
[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.
[vale] src/get-started/overview/workerpool.md#L125: src/get-started/overview/workerpool.md#L125
[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.
[vale] src/get-started/overview/workerpool.md#L131: src/get-started/overview/workerpool.md#L131
[Google.Passive] In general, use active voice instead of passive voice ('are returned').
[vale] src/get-started/overview/what-is-iexec.md#L13: src/get-started/overview/what-is-iexec.md#L13
[Google.Parens] Use parentheses judiciously.
[vale] src/get-started/overview/what-is-iexec.md#L22: src/get-started/overview/what-is-iexec.md#L22
[Google.Parens] Use parentheses judiciously.
[vale] src/get-started/overview/what-is-iexec.md#L24: src/get-started/overview/what-is-iexec.md#L24
[Google.Parens] Use parentheses judiciously.
[vale] src/get-started/overview/what-is-iexec.md#L25: src/get-started/overview/what-is-iexec.md#L25
[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.
[vale] src/get-started/overview/what-is-iexec.md#L57: src/get-started/overview/what-is-iexec.md#L57
[Google.Parens] Use parentheses judiciously.
[vale] src/get-started/overview/what-is-iexec.md#L59: src/get-started/overview/what-is-iexec.md#L59
[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.
[vale] src/get-started/overview/what-is-iexec.md#L60: src/get-started/overview/what-is-iexec.md#L60
[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.
[vale] src/get-started/overview/what-is-iexec.md#L70: src/get-started/overview/what-is-iexec.md#L70
[Google.Parens] Use parentheses judiciously.
[vale] src/references/iapp-generator.md#L40: src/references/iapp-generator.md#L40
[Google.Acronyms] Spell out 'TEE', if it's unfamiliar to the audience.