diff --git a/.vale.ini b/.vale.ini index febeefd3b..4e5238866 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,7 +6,6 @@ IgnoredScopes = code, tt, img, url, a SkippedScopes = script, style, pre, figure, code Packages = Google - Vocab = Mintlify # This is required since Vale doesn't officially support MDX @@ -23,9 +22,16 @@ Vale.Avoid = NO # Too aggressive about common technical terms TokenIgnores = (?sm)((?:import|export) .+?$), \ (?)(?!`), \ (<[A-Z]\w+>.+?<\/[A-Z]\w+>), \ -(<[^>]*>) +(<[^>]*>), \ +\{[^}]*\}, \ +(`[^`]*`), \ +(```[\s\S]*?```) BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \ -(?sm)^({.+.*}) +(?sm)^({.+.*})$, \ +(?sm)^```[\s\S]*?```$ + +CommentDelimiters = {/*, */} -CommentDelimiters = {/*, */} \ No newline at end of file +[changelog.mdx] +BasedOnStyles = diff --git a/.vale/styles/config/vocabularies/Mintlify/accept.txt b/.vale/styles/config/vocabularies/Mintlify/accept.txt index 8de2f7e81..7bee90e37 100644 --- a/.vale/styles/config/vocabularies/Mintlify/accept.txt +++ b/.vale/styles/config/vocabularies/Mintlify/accept.txt @@ -3,12 +3,14 @@ # ============================================================================= # MINTLIFY-SPECIFIC TERMS # ============================================================================= +APISection autoplay bearerAuth borderRadius camelCase discoverability (?i)callouts? +CTAs drilldown expandables favicon @@ -17,9 +19,11 @@ isHidden (?i)modetoggle myName myObject +navbar onboarding (?i)openapi repo +Ronan topbar (?i)tooltips? url @@ -40,6 +44,7 @@ CircleCI Clearbit Ctrl Cypress +Docusaurus Django DynamoDB Elasticsearch @@ -76,6 +81,7 @@ Mocha MongoDB MySQL Next.js +nginx Node.js NodeJS npx @@ -115,6 +121,7 @@ Webflow WebKit (?i)webpack WebStorm +Windsurf's Zapier # ============================================================================= @@ -123,10 +130,10 @@ Zapier agentic allowlist APIs +API's args async -autogenerated -autogenerating +autogenerat(e|ed|ing)? await bool boolean @@ -134,10 +141,11 @@ Blockquote Blockquotes cdn cli +CNAME +cpu config const cors -CNAME csrf css ctx @@ -171,6 +179,7 @@ lang len localhost md +(?i)Memoize middleware Multiline mvc @@ -186,6 +195,7 @@ orm params pnpm png +prefill(ing|ed)? prepend prepended prev @@ -234,8 +244,9 @@ ux val var vars +waypoints webhook -websocket +websockets? xhr xhr2 yaml diff --git a/analytics/feedback.mdx b/analytics/feedback.mdx index 485fcbe74..6e1f2bd7a 100644 --- a/analytics/feedback.mdx +++ b/analytics/feedback.mdx @@ -60,7 +60,7 @@ Best practices for setting feedback statuses: ### Filtering by status -Use the status filter to control which feedback is displayed. Uncheck a status to hide all feedback with that status. By default, all feedback is displayed. +Use the status filter to control which feedback is displayed. Clear a status to hide all feedback with that status. By default, all feedback is displayed. ### Adding internal notes diff --git a/authentication-personalization/overview.mdx b/authentication-personalization/overview.mdx index 7608e4edf..296730c14 100644 --- a/authentication-personalization/overview.mdx +++ b/authentication-personalization/overview.mdx @@ -27,7 +27,6 @@ Choose from three approaches to manage access and customize your documentation b **Choose partial authentication when:** - Offering public getting-started guides with private advanced features -- Running a freemium product where premium users get additional documentation - Publishing open-source docs with private enterprise sections **Choose personalization when:** diff --git a/contact-support.mdx b/contact-support.mdx index 9d2a2760b..899e7a6cd 100644 --- a/contact-support.mdx +++ b/contact-support.mdx @@ -16,7 +16,7 @@ Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tut Send us a message from your [dashboard](https://dashboard.mintlify.com/) by selecting **Support** in the sidebar. -![Gif showing how to access support from the dashboard by selecting the Support button, then selecting an option and typing a question in the support modal that pops up.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif) +![GIF showing how to access support from the dashboard by selecting the Support button, then selecting an option and typing a question in the support modal that pops up.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif) We aim to respond to all requests within 24 hours, but delays may occur during busy times. diff --git a/guides/claude-code.mdx b/guides/claude-code.mdx index cb30c28d5..fb9efe8da 100644 --- a/guides/claude-code.mdx +++ b/guides/claude-code.mdx @@ -34,7 +34,7 @@ Copy this example template or make changes for your docs specifications: ## Working relationship - You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so - ALWAYS ask for clarification rather than making assumptions -- NEVER lie, guess, or make up information +- NEVER lie, guess, or make up anything ## Project context - Format: MDX files with YAML frontmatter @@ -43,9 +43,9 @@ Copy this example template or make changes for your docs specifications: ## Content strategy - Document just enough for user success - not too much, not too little -- Prioritize accuracy and usability of information +- Prioritize accuracy and usability - Make content evergreen when possible -- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason +- Search for existing content before adding anything new. Avoid duplication unless it is done for a strategic reason - Check existing patterns for consistency - Start by making the smallest reasonable changes diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx index 5aea5d0c3..2c91872bb 100644 --- a/guides/hidden-pages.mdx +++ b/guides/hidden-pages.mdx @@ -16,7 +16,7 @@ If you want to hide pages for specific groups of users, use personalization to c A page is hidden if it is not included in your `docs.json` navigation. To hide a page, remove it from your navigation structure. -Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`. +Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`. See an [example of a hidden page](/guides/hidden-page-example). diff --git a/settings.mdx b/settings.mdx index c857b7d62..fd46b91a1 100644 --- a/settings.mdx +++ b/settings.mdx @@ -197,7 +197,7 @@ See [Themes](themes) for more information. - Font family, such as "Open Sans", "Playfair Display." + Font family, such as "Open Sans." Font weight, such as 400 or 700. Variable fonts support precise weights such as 550. @@ -343,7 +343,7 @@ See [Themes](themes) for more information. - Global navigation elements that appear accross all pages and sections. + Global navigation elements that appear across all pages and sections.