Standardize style and tone across docs #5652
Mintlify Validation (mintlify) - vale-spellcheck Failed
Found 66 suggested changes across 13 files in 3162.21ms
Details
Running Vale across on the following files affected by this PR:
- ai/contextual-menu.mdx
- ai/model-context-protocol.mdx
- api-playground/managing-page-visibility.mdx
- assistant/use.mdx
- dashboard/permissions.mdx
- deploy/preview-deployments.mdx
- deploy/vercel.mdx
- editor/branching-and-publishing.mdx
- editor/live-preview.mdx
- editor/navigation.mdx
- editor/pages.mdx
- editor/share-a-preview.mdx
- editor/tutorial.mdx
- guides/assistant-embed.mdx
- guides/branches.mdx
- guides/custom-frontend.mdx
- optimize/feedback.mdx
- optimize/pdf-exports.mdx
- quickstart.mdx
- workflows/enable.mdx
- workflows/manage.mdx
Attempting to initialize Vale linter...
Customer vale configuration detected. Attempting to sync packages...
Packages synced successfully.
Attempting to run Vale spellcheck...
Vale spellcheck completed successfully.
ai/model-context-protocol.mdx:
- 51:93 Use 'preceding' instead of 'above'.
api-playground/managing-page-visibility.mdx:
- 17:3 Use 'endpoints?' instead of 'Endpoints'.
- 19:3 Use 'endpoints?' instead of 'Endpoints'.
deploy/preview-deployments.mdx:
- 17:21 In general, use active voice instead of passive voice ('are created').
- 46:4 Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.
- 48:1 Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.
- 51:13 Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.
deploy/vercel.mdx:
- 3:136 Use 'JSON' instead of 'json'.
- 11:4 'vercel.json file' should use sentence-style capitalization.
- 11:11 Use 'JSON' instead of 'json'.
- 31:108 In general, use active voice instead of passive voice ('is found').
- 58:190 In general, use active voice instead of passive voice ('is hosted').
editor/branching-and-publishing.mdx:
- 7:16 Did you really mean 'autosaves'?
- 13:46 In general, use active voice instead of passive voice ('are stored').
- 41:63 In general, use active voice instead of passive voice ('are disabled').
- 51:92 In general, use active voice instead of passive voice ('is made').
- 73:57 Avoid using 'will'.
- 115:38 In general, use active voice instead of passive voice ('been approved').
- 121:23 In general, use active voice instead of passive voice ('is approved').
- 147:108 Use 'Cursor' instead of 'cursor'.
- 153:179 Use 'Cursor' instead of 'cursor'.
- 153:224 Use 'Cursor' instead of 'cursor'.
editor/navigation.mdx:
- 13:1 Use the Oxford comma in 'After creating an element, drag and'.
- 27:12 Don't put a space before or after a dash.
- 28:13 Don't put a space before or after a dash.
- 29:11 Don't put a space before or after a dash.
- 30:14 Don't put a space before or after a dash.
- 31:5 Use 'dropdowns?' instead of 'Dropdowns'.
- 31:16 Don't put a space before or after a dash.
- 32:12 Don't put a space before or after a dash.
- 32:15 Use 'dropdowns?' instead of 'Dropdown'.
- 33:15 Don't put a space before or after a dash.
- 34:15 Don't put a space before or after a dash.
- 35:16 Don't put a space before or after a dash.
- 43:26 Spell out 'NEW', if it's unfamiliar to the audience.
- 43:35 Spell out 'BETA', if it's unfamiliar to the audience.
editor/pages.mdx:
- 12:50 In general, use active voice instead of passive voice ('are read').
- 34:31 Use 'Cursor' instead of 'cursor'.
- 39:50 In general, use active voice instead of passive voice ('are read').
- 59:36 Did you really mean 'minimap'?
- 59:143 Did you really mean 'minimap'?
- 74:1 Use 'diffs?' instead of 'Diff'.
- 74:11 In general, use active voice instead of passive voice ('is read').
- 81:66 In general, use active voice instead of passive voice ('is removed').
- 85:132 In general, use active voice instead of passive voice ('is preserved').
- 91:30 Use 'sidebars?' instead of 'Sidebar'.
- 103:175 Use 'Cursor' instead of 'cursor'.
editor/share-a-preview.mdx:
- 9:86 Don't put a space before or after a dash.
- 9:124 In general, use active voice instead of passive voice ('are rendered').
- 18:114 Don't put a space before or after a dash.
- 18:128 Did you really mean 'reshare'?
editor/tutorial.mdx:
- 42:148 In general, use active voice instead of passive voice ('is built').
- 61:23 In general, use active voice instead of passive voice ('are approved').
guides/assistant-embed.mdx:
- 8:13 Avoid using 'will'.
- 76:2 Use semicolons judiciously.
- 120:14 Use semicolons judiciously.
- 121:2 Use semicolons judiciously.
- 125:84 Use semicolons judiciously.
- 176:47 Did you really mean 'handleSubmit'?
guides/branches.mdx:
- 11:84 In general, use active voice instead of passive voice ('is created').
- 11:104 In general, use active voice instead of passive voice ('are made').
- 11:142 In general, use active voice instead of passive voice ('is merged').
guides/custom-frontend.mdx:
- 2:9 Use 'headless' instead of 'Headless'.
- 3:16 Use 'headless' instead of 'Headless'.
- 163:31 Use 'sidebars?' instead of 'Sidebar'.
optimize/feedback.mdx:
- 84:30 In general, use active voice instead of passive voice ('been resolved').
Found 66 suggested changes across 13 files in 3162.21ms
Annotations
Check warning on line 51 in ai/model-context-protocol.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/model-context-protocol.mdx#L51
Use 'preceding' instead of 'above'.
Check warning on line 17 in api-playground/managing-page-visibility.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api-playground/managing-page-visibility.mdx#L17
Use 'endpoints?' instead of 'Endpoints'.
Check warning on line 19 in api-playground/managing-page-visibility.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api-playground/managing-page-visibility.mdx#L19
Use 'endpoints?' instead of 'Endpoints'.
Check warning on line 17 in deploy/preview-deployments.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/preview-deployments.mdx#L17
In general, use active voice instead of passive voice ('are created').
Check warning on line 46 in deploy/preview-deployments.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/preview-deployments.mdx#L46
Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.
Check warning on line 48 in deploy/preview-deployments.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/preview-deployments.mdx#L48
Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.
Check warning on line 51 in deploy/preview-deployments.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/preview-deployments.mdx#L51
Use 'redeploy(s|ed|ing|ment)?' instead of 'Redeploy'.
Check warning on line 3 in deploy/vercel.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/vercel.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 11 in deploy/vercel.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/vercel.mdx#L11
'vercel.json file' should use sentence-style capitalization.
Check warning on line 11 in deploy/vercel.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/vercel.mdx#L11
Use 'JSON' instead of 'json'.
Check warning on line 31 in deploy/vercel.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/vercel.mdx#L31
In general, use active voice instead of passive voice ('is found').
Check warning on line 58 in deploy/vercel.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
deploy/vercel.mdx#L58
In general, use active voice instead of passive voice ('is hosted').
Check warning on line 7 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L7
Did you really mean 'autosaves'?
Check warning on line 13 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L13
In general, use active voice instead of passive voice ('are stored').
Check warning on line 41 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L41
In general, use active voice instead of passive voice ('are disabled').
Check warning on line 51 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L51
In general, use active voice instead of passive voice ('is made').
Check warning on line 73 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L73
Avoid using 'will'.
Check warning on line 115 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L115
In general, use active voice instead of passive voice ('been approved').
Check warning on line 121 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L121
In general, use active voice instead of passive voice ('is approved').
Check warning on line 147 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L147
Use 'Cursor' instead of 'cursor'.
Check warning on line 153 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L153
Use 'Cursor' instead of 'cursor'.
Check warning on line 153 in editor/branching-and-publishing.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/branching-and-publishing.mdx#L153
Use 'Cursor' instead of 'cursor'.
Check warning on line 13 in editor/navigation.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/navigation.mdx#L13
Use the Oxford comma in 'After creating an element, drag and'.
Check warning on line 27 in editor/navigation.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/navigation.mdx#L27
Don't put a space before or after a dash.
Check warning on line 28 in editor/navigation.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
editor/navigation.mdx#L28
Don't put a space before or after a dash.