Improve SEO frontmatter across docs #5645
Mintlify Validation (mintlify) - vale-spellcheck Failed
Found 77 suggested changes across 28 files in 5164.22ms
Details
Running Vale across on the following files affected by this PR:
- agent/index.mdx
- api/agent/create-agent-job.mdx
- api/agent/get-agent-job.mdx
- api/agent/get-all-jobs.mdx
- api/agent/v2/create-agent-job.mdx
- api/agent/v2/get-agent-job.mdx
- api/agent/v2/send-message.mdx
- api/analytics/assistant-caller-stats.mdx
- api/analytics/assistant-conversations.mdx
- api/analytics/feedback-by-page.mdx
- api/analytics/feedback.mdx
- api/analytics/searches.mdx
- api/analytics/views.mdx
- api/analytics/visitors.mdx
- api/assistant/create-assistant-message-v2.mdx
- api/assistant/create-assistant-message.mdx
- api/assistant/get-page-content.mdx
- api/assistant/search.mdx
- api/preview/trigger.mdx
- api/update/status.mdx
- api/update/trigger.mdx
- components/cards.mdx
- editor-classic.mdx
- editor/collaborate.mdx
- editor/configurations.mdx
- editor/index.mdx
- editor/live-preview.mdx
- editor/navigation.mdx
- editor/pages.mdx
- editor/share-a-preview.mdx
- editor/tutorial.mdx
- optimize/search-boost.mdx
- workflows/create.mdx
- workflows/enable.mdx
- workflows/index.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.
api/agent/create-agent-job.mdx:
- 3:25 Use 'JSON' instead of 'json'.
- 12:60 In general, use active voice instead of passive voice ('are edited').
api/agent/get-agent-job.mdx:
- 3:25 Use 'JSON' instead of 'json'.
api/agent/get-all-jobs.mdx:
- 3:25 Use 'JSON' instead of 'json'.
api/agent/v2/create-agent-job.mdx:
- 3:25 Use 'JSON' instead of 'json'.
- 7:74 Don't put a space before or after a dash.
- 9:103 In general, use active voice instead of passive voice ('is populated').
api/agent/v2/get-agent-job.mdx:
- 3:25 Use 'JSON' instead of 'json'.
- 9:59 In general, use active voice instead of passive voice ('is populated').
api/agent/v2/send-message.mdx:
- 3:25 Use 'JSON' instead of 'json'.
- 7:68 In general, use active voice instead of passive voice ('is processed').
- 7:95 Don't put a space before or after a dash.
api/analytics/assistant-caller-stats.mdx:
- 3:29 Use 'JSON' instead of 'json'.
- 9:48 In general, use active voice instead of passive voice ('are distributed').
- 12:5 Use 'API' instead of 'api'.
api/analytics/assistant-conversations.mdx:
- 3:29 Use 'JSON' instead of 'json'.
- 23:5 Did you really mean 'resolutionStatus'?
- 24:5 Did you really mean 'queryCategory'?
api/analytics/feedback-by-page.mdx:
- 3:29 Use 'JSON' instead of 'json'.
api/analytics/feedback.mdx:
- 3:29 Use 'JSON' instead of 'json'.
api/analytics/searches.mdx:
- 3:29 Use 'JSON' instead of 'json'.
api/analytics/views.mdx:
- 3:29 Use 'JSON' instead of 'json'.
api/analytics/visitors.mdx:
- 3:29 Use 'JSON' instead of 'json'.
api/assistant/create-assistant-message-v2.mdx:
- 3:29 Use 'JSON' instead of 'json'.
api/assistant/create-assistant-message.mdx:
- 3:29 Use 'JSON' instead of 'json'.
api/assistant/get-page-content.mdx:
- 3:30 Use 'JSON' instead of 'json'.
api/assistant/search.mdx:
- 3:30 Use 'JSON' instead of 'json'.
api/preview/trigger.mdx:
- 3:20 Use 'JSON' instead of 'json'.
- 17:84 In general, use active voice instead of passive voice ('are opened').
components/cards.mdx:
- 3:112 Don't put a space before or after a dash.
editor-classic.mdx:
- 3:125 Did you really mean 'sunsetting'?
editor/collaborate.mdx:
- 25:17 Use 'Cursor' instead of 'cursor'.
- 32:248 Use 'Cursor' instead of 'cursor'.
- 40:13 Use 'Cursor' instead of 'cursor'.
editor/configurations.mdx:
- 3:120 Don't put a space before or after a dash.
- 3:138 Use 'JSON' instead of 'json'.
- 77:38 Use 'preceding' instead of 'above'.
- 86:97 Commas and periods go inside quotation marks.
- 86:111 In general, don't use an ellipsis.
editor/navigation.mdx:
- 3:132 Don't put a space before or after a dash.
- 3:156 Use 'JSON' instead of 'json'.
- 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:
- 3:63 Use 'Markdown' instead of 'markdown'.
- 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'?
- 72:202 Use semicolons judiciously.
- 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').
optimize/search-boost.mdx:
- 3:156 Use 'JSON' instead of 'json'.
workflows/index.mdx:
- 25:22 Don't put a space before or after a dash.
- 26:18 Don't put a space before or after a dash.
Found 77 suggested changes across 28 files in 5164.22ms
Annotations
Check warning on line 3 in api/agent/create-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/create-agent-job.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 12 in api/agent/create-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/create-agent-job.mdx#L12
In general, use active voice instead of passive voice ('are edited').
Check warning on line 3 in api/agent/get-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/get-agent-job.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/agent/get-all-jobs.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/get-all-jobs.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/agent/v2/create-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/create-agent-job.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 7 in api/agent/v2/create-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/create-agent-job.mdx#L7
Don't put a space before or after a dash.
Check warning on line 9 in api/agent/v2/create-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/create-agent-job.mdx#L9
In general, use active voice instead of passive voice ('is populated').
Check warning on line 3 in api/agent/v2/get-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/get-agent-job.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 9 in api/agent/v2/get-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/get-agent-job.mdx#L9
In general, use active voice instead of passive voice ('is populated').
Check warning on line 3 in api/agent/v2/send-message.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/send-message.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 7 in api/agent/v2/send-message.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/send-message.mdx#L7
In general, use active voice instead of passive voice ('is processed').
Check warning on line 7 in api/agent/v2/send-message.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/v2/send-message.mdx#L7
Don't put a space before or after a dash.
Check warning on line 3 in api/analytics/assistant-caller-stats.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/assistant-caller-stats.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 9 in api/analytics/assistant-caller-stats.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/assistant-caller-stats.mdx#L9
In general, use active voice instead of passive voice ('are distributed').
Check warning on line 12 in api/analytics/assistant-caller-stats.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/assistant-caller-stats.mdx#L12
Use 'API' instead of 'api'.
Check warning on line 3 in api/analytics/assistant-conversations.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/assistant-conversations.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 23 in api/analytics/assistant-conversations.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/assistant-conversations.mdx#L23
Did you really mean 'resolutionStatus'?
Check warning on line 24 in api/analytics/assistant-conversations.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/assistant-conversations.mdx#L24
Did you really mean 'queryCategory'?
Check warning on line 3 in api/analytics/feedback-by-page.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/feedback-by-page.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/analytics/feedback.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/feedback.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/analytics/searches.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/searches.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/analytics/views.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/views.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/analytics/visitors.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/analytics/visitors.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/assistant/create-assistant-message-v2.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/assistant/create-assistant-message-v2.mdx#L3
Use 'JSON' instead of 'json'.
Check warning on line 3 in api/assistant/create-assistant-message.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/assistant/create-assistant-message.mdx#L3
Use 'JSON' instead of 'json'.