Add emojis, shortcodes, and redeployment to Vale vocabulary #5476
Mintlify Validation (mintlify) - vale-spellcheck Failed
Found 504 suggested changes across 122 files in 34041.80ms
Details
Running Vale across all Markdown/MDX files in this repository...
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.
agent/slack.mdx:
- 54:10 Avoid first-person pronouns such as ' I '.
agent/workflows.mdx:
- 164:37 Did you really mean 'informat'?
- 238:14 Use 'cron' instead of 'Cron'.
- 257:14 Use 'cron' instead of 'Cron'.
- 301:14 Use 'cron' instead of 'Cron'.
ai/discord.mdx:
- 8:19 In general, use active voice instead of passive voice ('is deprecated').
ai/llmstxt.mdx:
- 3:38 Use 'LLMs?' instead of 'llms'.
- 14:57 Use 'LLMs?' instead of 'llms'.
- 21:67 Use 'LLMs?' instead of 'llms'.
- 25:12 Use 'LLMs?' instead of 'llms'.
- 28:4 'llms.txt structure' should use sentence-style capitalization.
- 28:4 Use 'LLMs?' instead of 'llms'.
- 69:72 Use 'LLMs?' instead of 'llms'.
ai/model-context-protocol.mdx:
- 47:93 Use 'preceding' instead of 'above'.
ai/skillmd.mdx:
- 48:15 'structure' should use sentence-style capitalization.
- 107:66 In general, use active voice instead of passive voice ('are discovered').
ai/slack-bot.mdx:
- 8:17 In general, use active voice instead of passive voice ('is deprecated').
api-playground/asyncapi-setup.mdx:
- 98:89 Use 'API' instead of 'api'.
api-playground/complex-data-types.mdx:
- 3:64 Did you really mean 'anyOf'?
- 3:75 Did you really mean 'allOf'?
api-playground/managing-page-visibility.mdx:
- 17:3 Use 'endpoints?' instead of 'Endpoints'.
- 19:3 Use 'endpoints?' instead of 'Endpoints'.
api-playground/mdx-setup.mdx:
- 9:4 Use 'setup' instead of 'Setup'.
- 9:4 'Setup' should use sentence-style capitalization.
api/agent/create-agent-job.mdx:
- 4:25 Use 'JSON' instead of 'json'.
- 13:60 In general, use active voice instead of passive voice ('are edited').
api/agent/get-agent-job.mdx:
- 4:25 Use 'JSON' instead of 'json'.
api/agent/get-all-jobs.mdx:
- 4:25 Use 'JSON' instead of 'json'.
api/agent/v2/create-agent-job.mdx:
- 4:25 Use 'JSON' instead of 'json'.
- 8:74 Don't put a space before or after a dash.
- 10:103 In general, use active voice instead of passive voice ('is populated').
api/agent/v2/get-agent-job.mdx:
- 4:25 Use 'JSON' instead of 'json'.
- 10:59 In general, use active voice instead of passive voice ('is populated').
api/agent/v2/send-message.mdx:
- 4:25 Use 'JSON' instead of 'json'.
- 8:68 In general, use active voice instead of passive voice ('is processed').
- 8:95 Don't put a space before or after a dash.
api/analytics/assistant-caller-stats.mdx:
- 4:29 Use 'JSON' instead of 'json'.
- 10:48 In general, use active voice instead of passive voice ('are distributed').
- 13:5 Use 'API' instead of 'api'.
api/analytics/assistant-conversations.mdx:
- 4:29 Use 'JSON' instead of 'json'.
- 24:5 Did you really mean 'queryCategory'?
api/analytics/feedback-by-page.mdx:
- 4:29 Use 'JSON' instead of 'json'.
api/analytics/feedback.mdx:
- 4:29 Use 'JSON' instead of 'json'.
api/analytics/searches.mdx:
- 4:29 Use 'JSON' instead of 'json'.
api/analytics/views.mdx:
- 4:29 Use 'JSON' instead of 'json'.
api/analytics/visitors.mdx:
- 4:29 Use 'JSON' instead of 'json'.
api/assistant/create-assistant-message-v2.mdx:
- 4:29 Use 'JSON' instead of 'json'.
api/assistant/create-assistant-message.mdx:
- 4:29 Use 'JSON' instead of 'json'.
api/assistant/get-page-content.mdx:
- 4:30 Use 'JSON' instead of 'json'.
api/assistant/search.mdx:
- 4:30 Use 'JSON' instead of 'json'.
api/introduction.mdx:
- 9:4 Use 'endpoints?' instead of 'Endpoints'.
api/preview/trigger.mdx:
- 4:20 Use 'JSON' instead of 'json'.
- 18:84 In general, use active voice instead of passive voice ('are opened').
assistant/index.mdx:
- 8:108 In general, use active voice instead of passive voice ('is enabled').
changelog.mdx:
- 35:55 In general, use active voice instead of passive voice ('been improved').
- 40:26 In general, use active voice instead of passive voice ('are deprecated').
- 40:158 In general, use active voice instead of passive voice ('be created').
- 76:124 In general, use active voice instead of passive voice ('is discovered').
- 80:222 In general, use active voice instead of passive voice ('is saved').
- 92:26 Use 'unavailable' instead of 'grayed-out'.
- 97:46 In general, use active voice instead of passive voice ('been redesigned').
- 104:34 In general, use active voice instead of passive voice ('being processed').
- 116:86 Did you really mean 'get_page'?
- 116:86 'get_page MCP tool' should use sentence-style capitalization.
- 132:83 Did you really mean 'autosave'?
- 134:74 Use 'WebM' instead of 'webm'.
- 134:84 Did you really mean 'mov'?
- 135:43 In general, use active voice instead of passive voice ('be disabled').
- 173:6 Did you really mean 'Composable'?
- 179:3 Use 'sidebars?' instead of 'Sidebar'.
- 212:19 In general, use active voice instead of passive voice ('being erased').
- 225:206 Did you really mean 'preloaded'?
- 241:107 Did you really mean 'virtualized'?
- 324:6 'Default Vale configuration updates' should use sentence-style capitalization.
- 326:80 Use 'md' instead of 'MD'.
- 326:221 Use 'md' instead of 'MD'.
- 341:11 Use 'Cursor' instead of 'cursor'.
- 397:16 Use 'capability' or 'feature' instead of 'functionality'.
- 428:13 'in groups' should use sentence-style capitalization.
- 516:15 Use 'Cursor' instead of 'cursor'.
- 526:17 'auto-generation' should use sentence-style capitalization.
- 536:37 Use 'Markdown' instead of 'markdown'.
- 536:86 In general, use active voice instead of passive voice ('is sent').
- 542:11 Use 'Markdown' instead of 'markdown'.
- 548:19 'auto-generation' should use sentence-style capitalization.
- 558:23 Use 'capability' or 'feature' instead of 'functionality'.
- 656:6 Use 'onboarding' instead of 'Onboarding'.
- 656:6 'Onboarding improvements' should use sentence-style capitalization.
- 675:111 In general, use active voice instead of passive voice ('are detected').
- 691:33 In general, use active voice instead of passive voice ('been redesigned').
- 700:66 In general, use active voice instead of passive voice ('being selected').
- 704:96 In general, use active voice instead of passive voice ('are opened').
- 726:27 Avoid using 'will'.
- 742:63 In general, use active voice instead of passive voice ('being sent').
- 743:48 Spell out 'IME', if it's unfamiliar to the audience.
- 751:110 In general, use active voice instead of passive voice ('be filtered').
- 767:85 In general, use active voice instead of passive voice ('being processed').
- 788:40 In general, use active voice instead of passive voice ('were defined').
- 788:114 Use 'preceding' instead of 'above'.
- 799:93 In general, use active voice instead of passive voice ('are guided').
- 818:45 In general, use active voice instead of passive voice ('are provided').
- 825:58 In general, use active voice instead of passive voice ('is provided').
- 840:20 In general, use active voice instead of passive voice ('be zoomed').
- 867:43 Don't use exclamation points in text.
- 868:36 In general, use active voice instead of passive voice ('been improved').
- 873:136 In general, use active voice instead of passive voice ('been fixed').
- 874:5 Use 'enums?' instead of 'Enum'.
- 874:117 In general, use active voice instead of passive voice ('are accepted').
- 876:5 Use 'enums?' instead of 'Enum'.
- 882:70 In general, use active voice instead of passive voice ('be enabled').
- 906:50 Use 'capability' or 'feature' instead of 'functionality'.
- 991:11 Did you really mean 'list_pull_requests'?
- 991:34 Did you really mean 'list_commits'?
- 1007:11 Use 'Cursor' instead of 'cursor'.
- 1023:20 Use 'OG' instead of 'og'.
- 1023:23 Use 'URL' instead of 'url'.
- 1023:23 Use 'URL' instead of 'url'.
- 1029:29 Use 'Markdown' instead of 'markdown'.
- 1029:66 Use 'todo' instead of 'TODO'.
- 1030:41 Did you really mean 'read_external_files'?
- 1046:113 In general, use active voice instead of passive voice ('being authenticated').
- 1085:32 Use 'capability' or 'feature' instead of 'functionality'.
- 1121:50 Use 'capability' or 'feature' instead of 'functionality'.
- 1141:106 Use 'Git' instead of 'git'.
- 1144:61 Avoid using 'will'.
- 1157:39 Use 'preceding' instead of 'above'.
- 1174:152 Use 'JSON' instead of 'json'.
- 1177:35 Use 'JSON' instead of 'json'.
- 1186:27 In general, use active voice instead of passive voice ('are handled').
- 1191:87 Avoid using 'will'.
- 1195:58 Did you really mean 'cdnjs'?
- 1195:82 Use 'CloudFront' instead of 'Cloudfront'.
- 1202:47 Spell out 'TXT', if it's unfamiliar to the audience.
- 1202:47 Use 'txt' instead of 'TXT'.
- 1207:55 Use 'capability' or 'feature' instead of 'functionality'.
- 1213:74 In general, use active voice instead of passive voice ('was configured').
- 1225:125 Use 'capability' or 'feature' instead of 'functionality'.
- 1241:172 Use 'MDX' instead of 'mdx'.
- 1243:76 Use 'Markdown' instead of 'markdown'.
- 1288:28 In general, use active voice instead of passive voice ('are redirected').
- 1306:187 Avoid using 'will'.
- 1307:5 Use 'email' instead of 'Email'.
- 1308:106 Put a nonbreaking space between the number and the unit in '50ms'.
- 1318:111 In general, use active voice instead of passive voice ('being set').
- 1319:44 In general, use active voice instead of passive voice ('being applied').
- 1334:45 Use 'capability' or 'feature' instead of 'functionality'.
- 1349:60 Spell out 'GANTT', if it's unfamiliar to the audience.
- 1349:60 Use 'Gantt' instead of 'GANTT'.
- 1392:6 Use 'subscribable' instead of 'Subscribable'.
- 1392:6 'Subscribable changelogs' should use sentence-style capitalization.
- 1416:6 'Web Editor 3.0' should use sentence-style capitalization.
- 1419:18 Did you really mean 'Jpe'?
- 1435:69 In general, use active voice instead of passive voice ('being brought').
- 1438:13 Use 'diffs?' instead of 'Diff'.
- 1442:6 'AI Translations in beta' should use sentence-style capitalization.
- 1476:59 Use 'device' instead of 'tablet'.
- 1486:12 Use 'JSON' instead of 'json'.
- 1506:6 'CI Checks' should use sentence-style capitalization.
- 1514:6 'More Themes' should use sentence-style capitalization.
- 1531:97 Avoid using 'will'.
- 1535:6 'AI Assistant Improvements' should use sentence-style capitalization.
- 1546:6 'Revamped API Playground' should use sentence-style capitalization.
- 1569:6 'AI Writer' should use sentence-style capitalization.
- 1576:6 'GitLab Integration Upgrade' should use sentence-style capitalization.
- 1580:6 'Web Editor' should use sentence-style capitalization.
- 1589:6 '/llms.txt support' should use sentence-style capitalization.
- 1589:7 Use 'LLMs?' instead of 'llms'.
- 1592:7 Use 'LLMs?' instead of 'llms'.
- 1598:162 Avoid using 'will'.
- 1614:6 'Code Line Highlighting' should use sentence-style capitalization.
- 1619:35 Use semicolons judiciously.
- 1621:26 Use semicolons judiciously.
cli/commands.mdx:
- 3:90 Use 'Dev' instead of 'dev'.
- 144:1 '````' should use sentence-style capitalization.
- 160:1 '````' should use sentence-style capitalization.
- 178:3 Use 'subcommands?' instead of 'Subcommand'.
- 244:47 In general, use active voice instead of passive voice ('is deprecated').
- 366:215 Did you really mean 'informat'?
cli/preview.mdx:
- 3:143 Use 'Dev' instead of 'dev'.
components/callouts.mdx:
- 2:9 Use 'callouts?' instead of 'Callouts'.
components/color.mdx:
- 25:8 'r.I' should have one space.
- 47:4 'Color.Row' should use sentence-style capitalization.
- 47:8 'r.R' should have one space.
components/expandables.mdx:
- 2:9 Use 'expandables' instead of 'Expandables'.
components/frames.mdx:
- 23:18 Use 'Markdown' instead of 'markdown'.
- 35:79 Use 'preceding' instead of 'above'.
- 56:80 Use 'Markdown' instead of 'markdown'.
components/icons.mdx:
- 19:7 In general, use active voice instead of passive voice ('are placed').
components/index.mdx:
- 35:10 Use 'callouts?' instead of 'Callouts'.
- 118:9 Use 'Git' instead of 'git'.
- 119:21 Use 'Mermaid' instead of 'mermaid'.
components/tabs.mdx:
- 85:111 Use 'REST' instead of 'rest'.
components/tiles.mdx:
- 60:36 In general, use active voice instead of passive voice ('is clicked').
components/tree.mdx:
- 30:6 'Tree.File' should use sentence-style capitalization.
- 30:9 'e.F' should have one space.
- 32:4 'Tree.Folder' should use sentence-style capitalization.
- 32:7 'e.F' should have one space.
- 107:22 In general, use active voice instead of passive voice ('is expanded').
- 111:26 In general, use active voice instead of passive voice ('be opened').
components/view.mdx:
- 14:48 In general, use active voice instead of passive voice ('is selected').
- 22:44 In general, use active voice instead of passive voice ('is selected').
- 41:44 In general, use active voice instead of passive voice ('is selected').
components/visibility.mdx:
- 27:39 Use 'Markdown' instead of 'markdown'.
create/changelogs.mdx:
- 101:5 'Subscribable changelogs' should use sentence-style capitalization.
- 101:5 Use 'subscribable' instead of 'Subscribable'.
create/files.mdx:
- 25:5 Use 'stylesheets?' instead of 'Stylesheets'.
- 51:7 In general, use active voice instead of passive voice ('are served').
create/image-embeds.mdx:
- 11:3 Use 'classnames?' instead of 'className'.
- 12:8 Use 'HTTPS?' instead of 'https'.
- 87:61 Use 'Cursor' instead of 'cursor'.
- 133:23 Use semicolons judiciously.
- 133:33 Use semicolons judiciously.
- 133:50 Use semicolons judiciously.
- 133:67 Use semicolons judiciously.
- 133:78 Use semicolons judiciously.
- 179:4 Use 'iframes?' instead of 'Iframes'.
create/personalization.mdx:
- 187:153 Use 'enums?' instead of 'Enum'.
create/redirects.mdx:
- 3:47 Use 'JSON' instead of 'json'.
customize/custom-domain.mdx:
- 50:135 In general, use active voice instead of passive voice ('is configured').
- 70:40 In general, use active voice instead of passive voice ('is reserved').
- 70:90 In general, use active voice instead of passive voice ('be redirected').
- 76:166 In general, use active voice instead of passive voice ('is emailed').
customize/custom-scripts.mdx:
- 67:47 Use 'preceding' instead of 'above'.
- 82:26 Did you really mean 'Scrollable'?
- 87:36 Did you really mean 'Scrollable'?
- 125:38 Use 'dropdowns?' instead of 'Dropdown'.
- 133:30 Use 'dropdowns?' instead of 'Dropdown'.
- 136:64 In general, use active voice instead of passive voice ('is selected').
- 149:19 Use 'callouts?' instead of 'Callout'.
- 171:41 Use 'preceding' instead of 'above'.
- 173:27 Use 'breadcrumbs?' instead of 'Breadcrumb'.
- 231:27 Use 'dropdowns?' instead of 'Dropdown'.
- 258:49 Use 'popovers?' instead of 'Popover'.
- 271:31 Use 'dropdowns?' instead of 'Dropdown'.
customize/fonts.mdx:
- 3:68 'Google Fonts' should use sentence-style capitalization.
customize/themes.mdx:
- 30:4 Use semicolons judiciously.
- 31:2 Use semicolons judiciously.
- 36:186 Use 'JSON' instead of 'json'.
dashboard/sso.mdx:
- 2:16 Use 'single sign-on' instead of 'sign-on'.
- 3:29 Use 'single sign-on' instead of 'sign-on'.
- 22:55 Use 'uri' instead of 'URI'.
- 28:22 Use 'uri' instead of 'URI'.
- 28:33 Use 'uri' instead of 'URI'.
- 53:55 Use 'uri' instead of 'URI'.
- 65:52 Use 'uri' instead of 'URI'.
- 166:5 'Google Workspace with SAML' should use sentence-style capitalization.
- 179:167 In general, use active voice instead of passive voice ('are blurred').
- 209:1 'application' is repeated!
- 212:69 Use 'uri' instead of 'URI'.
deploy/authentication-setup.mdx:
- 107:38 Use 'endpoints?' instead of 'Endpoint'.
- 108:11 Use 'logouts?' instead of 'Logout'.
- 140:5 Use 'logouts?' instead of 'Logout'.
deploy/cloudflare-firewall-troubleshooting.mdx:
- 67:15 Use 'uri' instead of 'URI'.
- 69:19 In general, use active voice instead of passive voice ('is enabled').
- 74:22 Use 'uri' instead of 'URI'.
deploy/cloudflare.mdx:
- 12:74 In general, use active voice instead of passive voice ('be managed').
- 115:120 In general, use active voice instead of passive voice ('be configured').
- 124:28 In general, use active voice instead of passive voice ('is set').
deploy/csp-configuration.mdx:
- 34:24 Use 'emojis?' instead of 'Emoji'.
deploy/deployments.mdx:
- 37:24 Avoid first-person pronouns such as 'my'.
- 46:42 In general, use active voice instead of passive voice ('be redirected').
- 46:137 In general, use active voice instead of passive voice ('be redirected').
deploy/ghes.mdx:
- 27:41 In general, use active voice instead of passive voice ('be allowed').
- 64:96 In general, use active voice instead of passive voice ('are required').
- 93:8 In general, use active voice instead of passive voice ('be redirected').
- 126:122 In general, use active voice instead of passive voice ('is located').
- 161:63 In general, use active voice instead of passive voice ('be shared').
- 166:57 In general, use active voice instead of passive voice ('is installed').
- 175:29 In general, use active voice instead of passive voice ('is integrated').
- 211:41 In general, use active voice instead of passive voice ('was configured').
- 222:23 In general, use active voice instead of passive voice ('being delivered').
- 223:24 In general, use active voice instead of passive voice ('were granted').
- 234:89 In general, use active voice instead of passive voice ('be required').
deploy/github.mdx:
- 55:4 'Install the GitHub App' should use sentence-style capitalization.
- 129:5 'GitHub App connection issues' should use sentence-style capitalization.
- 146:125 In general, use active voice instead of passive voice ('are disabled').
deploy/monorepo.mdx:
- 2:9 Use 'monorepo' instead of 'Monorepo'.
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/reverse-proxy.mdx:
- 3:53 Use 'nginx' instead of 'Nginx'.
- 3:71 Did you really mean 'Caddy'?
deploy/route53-cloudfront.mdx:
- 42:68 Use 'Dev' instead of 'dev'.
- 62:103 In general, use active voice instead of passive voice ('is hosted').
- 65:24 In general, use active voice instead of passive voice ('is hosted').
- 108:43 In general, use active voice instead of passive voice ('be narrowed').
- 122:136 Use 'Dev' instead of 'dev'.
- 157:21 In general, use active voice instead of passive voice ('are set').
- 167:39 In general, use active voice instead of passive voice ('is set').
- 175:4 'Connect with Route 53' should use sentence-style capitalization.
deploy/vercel-external-proxies.mdx:
- 3:69 Use 'nginx' instead of 'Nginx'.
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/configurations.mdx:
- 77:38 Use 'preceding' instead of 'above'.
- 85:97 Commas and periods go inside quotation marks.
- 85:111 In general, don't use an ellipsis.
editor/keyboard-shortcuts.mdx:
- 55:5 Use 'emojis?' instead of 'Emoji'.
- 96:9 Use 'Cursor' instead of 'cursor'.
- 97:9 Use 'Cursor' instead of 'cursor'.
- 97:16 Use 'preceding' instead of 'above'.
- 98:9 Use 'Cursor' instead of 'cursor'.
editor/media.mdx:
- 18:179 Use 'Cursor' instead of 'cursor'.
- 65:37 In general, don't use an ellipsis.
editor/navigation.mdx:
- 22:87 Use 'ungroup(s|ed|ing)?' instead of 'Ungroup'.
- 76:72 Use 'dropdowns?' instead of 'Dropdowns'.
- 78:1 Use 'dropdowns?' instead of 'Dropdowns'.
- 117:22 Spell out 'NEW', if it's unfamiliar to the audience.
- 117:31 Spell out 'BETA', if it's unfamiliar to the audience.
editor/pages.mdx:
- 31:50 In general, use active voice instead of passive voice ('are read').
- 58:40 Use 'Mermaid' instead of 'mermaid'.
- 62:30 Use 'Cursor' instead of 'cursor'.
- 103:5 Use 'sidebars?' instead of 'Sidebar'.
guides/accessibility.mdx:
- 63:50 In general, use active voice instead of passive voice ('is defined').
- 138:203 In general, use active voice instead of passive voice ('is included').
- 144:107 In general, use active voice instead of passive voice ('is associated').
- 173:1 Use 'iframes?' instead of 'Iframes'.
- 214:88 Spell out 'ASCII', if it's unfamiliar to the audience.
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/auth0.mdx:
- 22:45 In general, use active voice instead of passive voice ('be taken').
guides/automate-agent.mdx:
- 8:13 Avoid using 'will'.
- 262:23 Avoid first-person pronouns such as 'me'.
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/claude-code.mdx:
- 4:42 Use 'Claude' instead of 'CLAUDE'.
- 17:3 Use 'setup' instead of 'Setup'.
- 26:4 Use 'Claude' instead of 'CLAUDE'.
- 26:4 'CLAUDE.md template' should use sentence-style capitalization.
- 121:4 'Extend Claude Code' should use sentence-style capitalization.
- 125:5 'Automate with GitHub Actions' should use sentence-style capitalization.
- 126:165 In general, use active voice instead of passive voice ('are detected').
- 141:61 Use 'Claude' instead of 'CLAUDE'.
- 141:198 Use 'Claude' instead of 'CLAUDE'.
- 149:219 Use 'Claude' instead of 'CLAUDE'.
- 153:12 Use 'Claude' instead of 'CLAUDE'.
- 153:109 Avoid using 'will'.
guides/configure-automerge.mdx:
- 26:98 Use 'rulesets?' instead of 'Rulesets'.
- 27:91 Use 'rulesets?' instead of 'Rulesets'.
guides/content-types.mdx:
- 48:41 Use 'preceding' instead of 'above'.
- 52:45 In general, use active voice instead of passive voice ('being documented').
- 64:18 In general, use active voice instead of passive voice ('being opinionated').
- 66:203 In general, use active voice instead of passive voice ('been told').
- 83:37 Avoid using 'will'.
- 91:43 In general, use active voice instead of passive voice ('being described').
guides/cursor.mdx:
- 14:21 In general, use active voice instead of passive voice ('are stored').
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'.
guides/custom-layouts.mdx:
- 16:10 Use 'sidebars?' instead of 'Sidebar'.
guides/developer-documentation.mdx:
- 145:69 Avoid first-person pronouns such as ' I '.
- 145:109 Avoid first-person pronouns such as 'me'.
guides/geo.mdx:
- 8:186 Avoid first-person pronouns such as ' I '.
- 21:17 Use 'backlinks?' instead of 'Backlinks'.
- 23:53 Use 'scannable' instead of 'Scannable'.
- 31:168 In general, use active voice instead of passive voice ('be cited').
- 37:223 In general, use active voice instead of passive voice ('is exceeded').
- 58:178 In general, don't use an ellipsis.
- 138:229 In general, use active voice instead of passive voice ('is required').
- 170:166 In general, use active voice instead of passive voice ('are blocked').
- 178:10 Avoid first-person pronouns such as ' I '.
- 179:21 Avoid first-person pronouns such as ' I '.
- 180:9 Avoid first-person pronouns such as 'me'.
- 183:30 In general, use active voice instead of passive voice ('is cited').
- 188:159 In general, use active voice instead of passive voice ('is broken').
- 206:276 Use semicolons judiciously.
guides/help-center.mdx:
- 182:14 Avoid first-person pronouns such as ' I '.
- 182:24 Avoid first-person pronouns such as 'my'.
- 183:16 Avoid first-person pronouns such as 'my'.
- 184:14 Avoid first-person pronouns such as ' I '.
guides/improving-docs.mdx:
- 44:68 In general, use active voice instead of passive voice ('being found').
- 95:209 Use 'REST' instead of 'rest'.
- 113:192 In general, use active voice instead of passive voice ('been updated').
- 117:400 Avoid using 'will'.
guides/internationalization.mdx:
- 660:15 Use 'PNG' instead of 'png'.
- 662:19 Use 'PNG' instead of 'png'.
- 664:19 Use 'PNG' instead of 'png'.
- 738:24 In general, use active voice instead of passive voice ('be translated').
- 738:136 In general, use active voice instead of passive voice ('be translated').
- 742:148 In general, use active voice instead of passive voice ('are configured').
guides/knowledge-base.mdx:
- 180:58 Avoid first-person pronouns such as ' I '.
guides/linking.mdx:
- 128:85 Avoid using 'will'.
- 142:98 In general, use active voice instead of passive voice ('is organized').
- 199:1 Use the Oxford comma in 'Without redirects, bookmarked and'.
guides/maintenance.mdx:
- 50:27 In general, use active voice instead of passive voice ('been updated').
- 60:1 Use 'automations?' instead of 'Automation'.
- 64:52 In general, use active voice instead of passive voice ('is generated').
- 65:140 In general, use active voice instead of passive voice ('is merged').
- 75:79 In general, don't use an ellipsis.
- 81:197 In general, use active voice instead of passive voice ('be fixed').
- 96:126 In general, use active voice instead of passive voice ('is deprecated').
- 96:149 Avoid using 'will'.
- 96:154 In general, use active voice instead of passive voice ('be removed').
guides/media.mdx:
- 86:86 In general, use active voice instead of passive voice ('being discussed').
- 87:27 'frequently-changing' doesn't need a hyphen.
- 88:107 In general, use active voice instead of passive voice ('be updated').
guides/navigation.mdx:
- 25:18 In general, use active voice instead of passive voice ('was broken').
- 25:81 In general, use active voice instead of passive voice ('be organized').
- 133:182 In general, use active voice instead of passive voice ('be combined').
guides/seo.mdx:
- 28:24 Avoid using 'will'.
- 30:49 In general, don't use an ellipsis.
- 30:77 In general, don't use an ellipsis.
- 72:105 Use 'preceding' instead of 'above'.
- 113:28 In general, use active voice instead of passive voice ('are rendered').
- 149:284 Don't put a space before or after a dash.
- 161:50 Don't put a space before or after a dash.
- 161:133 In general, use active voice instead of passive voice ('been touched').
- 165:153 In general, use active voice instead of passive voice ('being cited').
- 165:260 Don't put a space before or after a dash.
- 165:318 Don't put a space before or after a dash.
- 169:261 Don't put a space before or after a dash.
guides/style-and-tone.mdx:
- 40:94 In general, use active voice instead of passive voice ('is returned').
- 44:15 In general, use active voice instead of passive voice ('is scanned').
- 52:88 In general, use active voice instead of passive voice ('be split').
- 68:33 In general, use active voice instead of passive voice ('is generated').
- 105:45 In general, use active voice instead of passive voice ('are capitalized').
- 113:71 In general, use active voice instead of passive voice ('been reviewed').
- 120:96 In general, use active voice instead of passive voice ('are caught').
- 135:122 In general, use active voice instead of passive voice ('is validated').
guides/understand-your-audience.mdx:
- 14:19 In general, use active voice instead of passive voice ('be written').
- 76:132 Avoid using 'will'.
- 84:53 Use 'preceding' instead of 'above'.
guides/windsurf.mdx:
- 12:37 In general, use active voice instead of passive voice ('be tuned').
- 14:23 In general, use active voice instead of passive voice ('are stored').
- 41:32 'docs.json' should use sentence-style capitalization.
- 41:37 Use 'JSON' instead of 'json'.
- 68:22 Use 'JSON' instead of 'json'.
- 70:5 Use 'callouts?' instead of 'Callouts'.
index.mdx:
- 10:8 Use 'classnames?' instead of 'className'.
- 12:103 Use 'PNG' instead of 'png'.
- 24:4 Use semicolons judiciously.
- 25:2 Use semicolons judiciously.
integrations/analytics/adobe.mdx:
- 29:4 'Get your Launch URL' should use sentence-style capitalization.
integrations/analytics/google-analytics.mdx:
- 11:4 'Connect GA4 to Mintlify' should use sentence-style capitalization.
- 25:32 Use 'JSON' instead of 'json'.
integrations/analytics/overview.mdx:
- 568:4 Use 'setup' instead of 'Setup'.
- 568:4 'Setup' should use sentence-style capitalization.
- 717:77 Use 'Markdown' instead of 'markdown'.
integrations/analytics/posthog.mdx:
- 49:20 In general, use active voice instead of passive voice ('are enabled').
integrations/analytics/segment.mdx:
- 3:129 Did you really mean 'CRMs'?
integrations/privacy/osano.mdx:
- 9:4 Use 'setup' instead of 'Setup'.
- 9:4 'Setup' should use sentence-style capitalization.
integrations/privacy/overview.mdx:
- 29:17 In general, use active voice instead of passive voice ('are set').
integrations/sdks/speakeasy.mdx:
- 29:71 In general, use active voice instead of passive voice ('is emphasized').
- 29:146 In general, use active voice instead of passive voice ('is emphasized').
migration-services/enterprise.mdx:
- 42:101 Did you really mean 'timeframe'?
- 55:42 In general, use active voice instead of passive voice ('been migrated').
- 62:16 In general, use active voice instead of passive voice ('are applied').
- 63:29 In general, use active voice instead of passive voice ('are used').
- 101:155 Did you really mean 'timeframe'?
- 114:147 In general, use active voice instead of passive voice ('is needed').
- 118:110 In general, use active voice instead of passive voice ('be included').
migration-services/pro.mdx:
- 45:105 Did you really mean 'timeframe'?
- 58:44 In general, use active voice instead of passive voice ('been migrated').
- 65:18 In general, use active voice instead of passive voice ('are applied').
- 66:31 In general, use active voice instead of passive voice ('are used').
- 104:159 Did you really mean 'timeframe'?
- 121:114 In general, use active voice instead of passive voice ('be included').
optimize/feedback.mdx:
- 84:30 In general, use active voice instead of passive voice ('been resolved').
organize/hidden-page-example.mdx:
- 6:11 In general, use active voice instead of passive voice ('is hidden').
- 17:45 In general, use active voice instead of passive voice ('are indexed').
- 50:49 In general, use active voice instead of passive voice ('be used').
organize/hidden-pages.mdx:
- 69:46 In general, use active voice instead of passive voice ('is hidden').
- 103:28 Spell out 'NOT', if it's unfamiliar to the audience.
organize/navigation.mdx:
- 3:117 Use 'JSON' instead of 'json'.
- 441:4 Use 'dropdowns?' instead of 'Dropdowns'.
- 443:1 Use 'dropdowns?' instead of 'Dropdowns'.
- 1012:4 Use 'breadcrumbs?' instead of 'Breadcrumbs'.
- 1014:1 Use 'breadcrumbs?' instead of 'Breadcrumbs'.
organize/pages.mdx:
- 16:3 Use 'sidebars?' instead of 'Sidebar'.
organize/settings-api.mdx:
- 3:145 Use 'JSON' instead of 'json'.
- 176:6 Use 'URL' instead of 'url'.
- 176:6 Use 'URL' instead of 'url'.
- 176:12 Commas and periods go inside quotation marks.
organize/settings-appearance.mdx:
- 3:85 Use 'JSON' instead of 'json'.
- 85:25 Use 'SVGs?' instead of 'svg'.
organize/settings-integrations.mdx:
- 3:136 Use 'JSON' instead of 'json'.
organize/settings-reference.mdx:
- 2:14 Use 'JSON' instead of 'json'.
- 3:49 Use 'JSON' instead of 'json'.
- 154:1 Use 'sidebars?' instead of 'Sidebar'.
- 160:1 Use 'dropdowns?' instead of 'Dropdown'.
- 206:1 Use 'sidebars?' instead of 'Sidebar'.
- 212:1 Use 'dropdowns?' instead of 'Dropdown'.
- 236:75 Use semicolons judiciously.
- 238:46 Don't put a space before or after a dash.
organize/settings-seo.mdx:
- 3:46 Use 'JSON' instead of 'json'.
organize/settings-structure.mdx:
- 3:145 Use 'JSON' instead of 'json'.
- 185:3 Use 'sidebars?' instead of 'Sidebar'.
- 205:221 Use semicolons judiciously.
organize/settings.mdx:
- 3:68 Use 'JSON' instead of 'json'.
snippets/vercel-json-generator.mdx:
- 12:19 Use 'API' instead of 'api'.
- 20:30 Use 'LLMs?' instead of 'llms'.
- 21:57 Use 'LLMs?' instead of 'llms'.
- 28:38 Use 'XML' instead of 'xml'.
- 66:13 Use 'subdomains?' instead of 'Subdomain'.
- 77:18 Use 'classnames?' instead of 'className'.
Found 504 suggested changes across 122 files in 34041.80ms
Annotations
Check warning on line 54 in agent/slack.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
agent/slack.mdx#L54
Avoid first-person pronouns such as ' I '.
Check warning on line 164 in agent/workflows.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
agent/workflows.mdx#L164
Did you really mean 'informat'?
Check warning on line 238 in agent/workflows.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
agent/workflows.mdx#L238
Use 'cron' instead of 'Cron'.
Check warning on line 257 in agent/workflows.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
agent/workflows.mdx#L257
Use 'cron' instead of 'Cron'.
Check warning on line 301 in agent/workflows.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
agent/workflows.mdx#L301
Use 'cron' instead of 'Cron'.
Check warning on line 8 in ai/discord.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/discord.mdx#L8
In general, use active voice instead of passive voice ('is deprecated').
Check warning on line 3 in ai/llmstxt.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/llmstxt.mdx#L3
Use 'LLMs?' instead of 'llms'.
Check warning on line 14 in ai/llmstxt.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/llmstxt.mdx#L14
Use 'LLMs?' instead of 'llms'.
Check warning on line 21 in ai/llmstxt.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/llmstxt.mdx#L21
Use 'LLMs?' instead of 'llms'.
Check warning on line 25 in ai/llmstxt.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/llmstxt.mdx#L25
Use 'LLMs?' instead of 'llms'.
Check warning on line 28 in ai/llmstxt.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/llmstxt.mdx#L28
'llms.txt structure' should use sentence-style capitalization.
Check warning on line 28 in ai/llmstxt.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/llmstxt.mdx#L28
Use 'LLMs?' instead of 'llms'.
Check warning on line 69 in ai/llmstxt.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/llmstxt.mdx#L69
Use 'LLMs?' instead of 'llms'.
Check warning on line 47 in ai/model-context-protocol.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/model-context-protocol.mdx#L47
Use 'preceding' instead of 'above'.
Check warning on line 48 in ai/skillmd.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/skillmd.mdx#L48
'structure' should use sentence-style capitalization.
Check warning on line 107 in ai/skillmd.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/skillmd.mdx#L107
In general, use active voice instead of passive voice ('are discovered').
Check warning on line 8 in ai/slack-bot.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
ai/slack-bot.mdx#L8
In general, use active voice instead of passive voice ('is deprecated').
Check warning on line 98 in api-playground/asyncapi-setup.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api-playground/asyncapi-setup.mdx#L98
Use 'API' instead of 'api'.
Check warning on line 3 in api-playground/complex-data-types.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api-playground/complex-data-types.mdx#L3
Did you really mean 'anyOf'?
Check warning on line 3 in api-playground/complex-data-types.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api-playground/complex-data-types.mdx#L3
Did you really mean 'allOf'?
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 9 in api-playground/mdx-setup.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api-playground/mdx-setup.mdx#L9
Use 'setup' instead of 'Setup'.
Check warning on line 9 in api-playground/mdx-setup.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api-playground/mdx-setup.mdx#L9
'Setup' should use sentence-style capitalization.
Check warning on line 4 in api/agent/create-agent-job.mdx
mintlify / Mintlify Validation (mintlify) - vale-spellcheck
api/agent/create-agent-job.mdx#L4
Use 'JSON' instead of 'json'.