Skip to content
Documentation Quality

refactor: Refresh protocol documentation section #323

Sign in to view logs

refactor: Refresh protocol documentation section

refactor: Refresh protocol documentation section #323

Triggered via pull request December 5, 2025 16:39
@zguesmizguesmi
synchronize #98
refactor/refactor-protocol-section
Status Success
Total duration 20s
Artifacts –

vale.yml

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

Annotations

23 errors, 14 warnings, and 46 notices
[vale] src/protocol/tee/intel-sgx.md#L18: src/protocol/tee/intel-sgx.md#L18
[Vale.Terms] Use 'intel' instead of 'Intel'.
[vale] src/protocol/tee/intel-sgx.md#L69: src/protocol/tee/intel-sgx.md#L69
[Vale.Terms] Use 'intel' instead of 'Intel'.
[vale] src/protocol/tee/intel-sgx.md#L71: src/protocol/tee/intel-sgx.md#L71
[Vale.Terms] Use 'intel' instead of 'Intel'.
[vale] src/protocol/proof-of-contribution.md#L49: src/protocol/proof-of-contribution.md#L49
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/protocol/proof-of-contribution.md#L60: src/protocol/proof-of-contribution.md#L60
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/protocol/proof-of-contribution.md#L87: src/protocol/proof-of-contribution.md#L87
[Vale.Spelling] Did you really mean 'monetizable'?
[vale] src/protocol/proof-of-contribution.md#L103: src/protocol/proof-of-contribution.md#L103
[Vale.Repetition] 'the' is repeated!
[vale] src/protocol/proof-of-contribution.md#L108: src/protocol/proof-of-contribution.md#L108
[Vale.Spelling] Did you really mean 'requester's'?
[vale] src/protocol/proof-of-contribution.md#L120: src/protocol/proof-of-contribution.md#L120
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/protocol/proof-of-contribution.md#L150: src/protocol/proof-of-contribution.md#L150
[Vale.Terms] Use 'Permissioning' instead of 'permissioning'.
[vale] src/protocol/proof-of-contribution.md#L172: src/protocol/proof-of-contribution.md#L172
[Vale.Terms] Use 'apporder' instead of 'AppOrder'.
[vale] src/protocol/proof-of-contribution.md#L172: src/protocol/proof-of-contribution.md#L172
[Google.EmDash] Don't put a space before or after a dash.
[vale] src/protocol/proof-of-contribution.md#L173: src/protocol/proof-of-contribution.md#L173
[Vale.Terms] Use 'datasetorder' instead of 'DatasetOrder'.
[vale] src/protocol/proof-of-contribution.md#L173: src/protocol/proof-of-contribution.md#L173
[Google.EmDash] Don't put a space before or after a dash.
[vale] src/protocol/proof-of-contribution.md#L174: src/protocol/proof-of-contribution.md#L174
[Vale.Terms] Use 'workerpoolorder' instead of 'WorkerpoolOrder'.
[vale] src/protocol/proof-of-contribution.md#L174: src/protocol/proof-of-contribution.md#L174
[Google.EmDash] Don't put a space before or after a dash.
[vale] src/protocol/proof-of-contribution.md#L175: src/protocol/proof-of-contribution.md#L175
[Vale.Terms] Use 'requestorder' instead of 'RequestOrder'.
[vale] src/protocol/proof-of-contribution.md#L175: src/protocol/proof-of-contribution.md#L175
[Google.EmDash] Don't put a space before or after a dash.
[vale] src/protocol/proof-of-contribution.md#L179: src/protocol/proof-of-contribution.md#L179
[Vale.Terms] Use 'Workerpool' instead of 'workerpool'.
[vale] src/protocol/proof-of-contribution.md#L183: src/protocol/proof-of-contribution.md#L183
[Google.Latin] Use 'for example' instead of 'e.g.'.
[vale] src/protocol/proof-of-contribution.md#L187: src/protocol/proof-of-contribution.md#L187
[Vale.Terms] Use 'apporder' instead of 'AppOrder'.
[vale] src/protocol/proof-of-contribution.md#L204: src/protocol/proof-of-contribution.md#L204
[Vale.Terms] Use 'datasetorder' instead of 'DatasetOrder'.
[vale] src/protocol/proof-of-contribution.md#L221: src/protocol/proof-of-contribution.md#L221
[Vale.Terms] Use 'workerpoolorder' instead of 'WorkerpoolOrder'.
[vale] src/protocol/tee/intel-sgx.md#L71: src/protocol/tee/intel-sgx.md#L71
[Google.WordList] Use 'app' instead of 'application'.
[vale] src/protocol/tee/intel-sgx.md#L71: src/protocol/tee/intel-sgx.md#L71
[Google.Will] Avoid using 'will'.
[vale] src/protocol/proof-of-contribution.md#L8: src/protocol/proof-of-contribution.md#L8
[Google.Headings] 'Proof-of-Contribution (PoCo)' should use sentence-style capitalization.
[vale] src/protocol/proof-of-contribution.md#L10: src/protocol/proof-of-contribution.md#L10
[Google.Headings] 'What is PoCo?' should use sentence-style capitalization.
[vale] src/protocol/proof-of-contribution.md#L25: src/protocol/proof-of-contribution.md#L25
[Google.Headings] 'Why PoCo matters?' should use sentence-style capitalization.
[vale] src/protocol/proof-of-contribution.md#L39: src/protocol/proof-of-contribution.md#L39
[Google.Colons] ': P' should be in lowercase.
[vale] src/protocol/proof-of-contribution.md#L66: src/protocol/proof-of-contribution.md#L66
[Google.WordList] Use 'app' instead of 'application'.
[vale] src/protocol/proof-of-contribution.md#L81: src/protocol/proof-of-contribution.md#L81
[Google.Ellipses] In general, don't use an ellipsis.
[vale] src/protocol/proof-of-contribution.md#L118: src/protocol/proof-of-contribution.md#L118
[Google.WordList] Use 'app' instead of 'application'.
[vale] src/protocol/proof-of-contribution.md#L172: src/protocol/proof-of-contribution.md#L172
[Google.WordList] Use 'app' instead of 'application'.
[vale] src/protocol/proof-of-contribution.md#L187: src/protocol/proof-of-contribution.md#L187
[Google.Headings] 'AppOrder' should use sentence-style capitalization.
[vale] src/protocol/proof-of-contribution.md#L204: src/protocol/proof-of-contribution.md#L204
[Google.Headings] 'DatasetOrder' should use sentence-style capitalization.
[vale] src/protocol/proof-of-contribution.md#L221: src/protocol/proof-of-contribution.md#L221
[Google.Headings] 'WorkerpoolOrder' should use sentence-style capitalization.
[vale] src/protocol/proof-of-contribution.md#L240: src/protocol/proof-of-contribution.md#L240
[Google.Headings] 'RequesterOrder' should use sentence-style capitalization.
[vale] src/protocol/tee/intel-sgx.md#L69: src/protocol/tee/intel-sgx.md#L69
[Google.Contractions] Use 'isn't' instead of 'is not'.
[vale] src/protocol/tee/intel-sgx.md#L70: src/protocol/tee/intel-sgx.md#L70
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/tee/intel-sgx.md#L70: src/protocol/tee/intel-sgx.md#L70
[Google.Contractions] Use 'aren't' instead of 'are not'.
[vale] src/protocol/tee/intel-sgx.md#L71: src/protocol/tee/intel-sgx.md#L71
[Google.Contractions] Use 'won't' instead of 'will not'.
[vale] src/protocol/proof-of-contribution.md#L8: src/protocol/proof-of-contribution.md#L8
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L10: src/protocol/proof-of-contribution.md#L10
[Google.Contractions] Use 'what's' instead of 'What is'.
[vale] src/protocol/proof-of-contribution.md#L12: src/protocol/proof-of-contribution.md#L12
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L14: src/protocol/proof-of-contribution.md#L14
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L14: src/protocol/proof-of-contribution.md#L14
[Google.Passive] In general, use active voice instead of passive voice ('are executed').
[vale] src/protocol/proof-of-contribution.md#L27: src/protocol/proof-of-contribution.md#L27
[Google.Passive] In general, use active voice instead of passive voice ('is built').
[vale] src/protocol/proof-of-contribution.md#L35: src/protocol/proof-of-contribution.md#L35
[Google.Passive] In general, use active voice instead of passive voice ('are handled').
[vale] src/protocol/proof-of-contribution.md#L37: src/protocol/proof-of-contribution.md#L37
[Google.Passive] In general, use active voice instead of passive voice ('are applied').
[vale] src/protocol/proof-of-contribution.md#L55: src/protocol/proof-of-contribution.md#L55
[Google.Contractions] Use 'what's' instead of 'what is'.
[vale] src/protocol/proof-of-contribution.md#L55: src/protocol/proof-of-contribution.md#L55
[Google.Passive] In general, use active voice instead of passive voice ('is paid').
[vale] src/protocol/proof-of-contribution.md#L56: src/protocol/proof-of-contribution.md#L56
[Google.Passive] In general, use active voice instead of passive voice ('is considered').
[vale] src/protocol/proof-of-contribution.md#L61: src/protocol/proof-of-contribution.md#L61
[Google.Passive] In general, use active voice instead of passive voice ('is needed').
[vale] src/protocol/proof-of-contribution.md#L68: src/protocol/proof-of-contribution.md#L68
[Google.Passive] In general, use active voice instead of passive voice ('is measured').
[vale] src/protocol/proof-of-contribution.md#L69: src/protocol/proof-of-contribution.md#L69
[Google.Passive] In general, use active voice instead of passive voice ('is verified').
[vale] src/protocol/proof-of-contribution.md#L76: src/protocol/proof-of-contribution.md#L76
[Google.Contractions] Use 'can't' instead of 'cannot'.
[vale] src/protocol/proof-of-contribution.md#L79: src/protocol/proof-of-contribution.md#L79
[Google.Passive] In general, use active voice instead of passive voice ('are transferred').
[vale] src/protocol/proof-of-contribution.md#L79: src/protocol/proof-of-contribution.md#L79
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L81: src/protocol/proof-of-contribution.md#L81
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L83: src/protocol/proof-of-contribution.md#L83
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L84: src/protocol/proof-of-contribution.md#L84
[Google.Passive] In general, use active voice instead of passive voice ('are provisioned').
[vale] src/protocol/proof-of-contribution.md#L105: src/protocol/proof-of-contribution.md#L105
[Google.Passive] In general, use active voice instead of passive voice ('is finalized').
[vale] src/protocol/proof-of-contribution.md#L105: src/protocol/proof-of-contribution.md#L105
[Google.Passive] In general, use active voice instead of passive voice ('are released').
[vale] src/protocol/proof-of-contribution.md#L118: src/protocol/proof-of-contribution.md#L118
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L119: src/protocol/proof-of-contribution.md#L119
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L121: src/protocol/proof-of-contribution.md#L121
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L124: src/protocol/proof-of-contribution.md#L124
[Google.Passive] In general, use active voice instead of passive voice ('are combined').
[vale] src/protocol/proof-of-contribution.md#L124: src/protocol/proof-of-contribution.md#L124
[Google.Passive] In general, use active voice instead of passive voice ('is created').
[vale] src/protocol/proof-of-contribution.md#L132: src/protocol/proof-of-contribution.md#L132
[Google.Passive] In general, use active voice instead of passive voice ('be created').
[vale] src/protocol/proof-of-contribution.md#L135: src/protocol/proof-of-contribution.md#L135
[Google.Passive] In general, use active voice instead of passive voice ('is used').
[vale] src/protocol/proof-of-contribution.md#L144: src/protocol/proof-of-contribution.md#L144
[Google.Passive] In general, use active voice instead of passive voice ('were published').
[vale] src/protocol/proof-of-contribution.md#L159: src/protocol/proof-of-contribution.md#L159
[Google.Passive] In general, use active voice instead of passive voice ('is created').
[vale] src/protocol/proof-of-contribution.md#L160: src/protocol/proof-of-contribution.md#L160
[Google.Contractions] Use 'doesn't' instead of 'does not'.
[vale] src/protocol/proof-of-contribution.md#L162: src/protocol/proof-of-contribution.md#L162
[Google.Passive] In general, use active voice instead of passive voice ('are submitted').
[vale] src/protocol/proof-of-contribution.md#L172: src/protocol/proof-of-contribution.md#L172
[Google.Passive] In general, use active voice instead of passive voice ('be used').
[vale] src/protocol/proof-of-contribution.md#L173: src/protocol/proof-of-contribution.md#L173
[Google.Passive] In general, use active voice instead of passive voice ('be accessed').
[vale] src/protocol/proof-of-contribution.md#L181: src/protocol/proof-of-contribution.md#L181
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L181: src/protocol/proof-of-contribution.md#L181
[Google.Passive] In general, use active voice instead of passive voice ('be matched').
[vale] src/protocol/proof-of-contribution.md#L273: src/protocol/proof-of-contribution.md#L273
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L279: src/protocol/proof-of-contribution.md#L279
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L280: src/protocol/proof-of-contribution.md#L280
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L281: src/protocol/proof-of-contribution.md#L281
[Google.Parens] Use parentheses judiciously.
[vale] src/protocol/proof-of-contribution.md#L282: src/protocol/proof-of-contribution.md#L282
[Google.Parens] Use parentheses judiciously.