Commit Graph

47 Commits

Author SHA1 Message Date
mintlify-development[bot] 49cf2c444c docs: condense quickstart page 2026-05-12 18:17:45 +00:00
mintlify[bot] 9687438d0d Document new CSS selector data attributes (#5170)
* Add new CSS selector attributes for tabs and topbar components

Generated-By: mintlify-agent

* Clarify CSS selector data attribute docs

- Add note that TabsBarItem uses a class selector (`.nav-tabs-item`) rather than a custom element name, and explain why
- Note that data-active does not apply to dropdown-style TabsBarItems
- Add intro sentence explaining the purpose of data-component-name selectors
- Note that PrimaryHeaderButton is Sequoia theme only
- Fix capitalization of TableOfContentsItem (deepest) description for consistency

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Add Mermaid data-component-name selectors to CSS reference

Documents mermaid-container (outer wrapper) and mermaid-controls-wrapper
(zoom/pan controls overlay) — both use data-component-name in the client
source and are distinct from the existing `mermaid` class selector which
targets only the inner SVG element.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Update custom-scripts.mdx

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Replace internal React names with plain-English labels in data attributes

Labels like DropdownItem, MobileNavTabsBarItem, and MermaidContainer are
internal component names not meaningful to users writing CSS. Replaced with
descriptions of what each element is (e.g. "Active item in a nav dropdown").

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-06 14:09:27 -07:00
Ethan Palm 59c05c29a6 Revert "make it relative urls again (#5074)" (#5075)
This reverts commit 86bb587a76.
2026-04-01 13:47:55 -07:00
ryan nguyen 86bb587a76 make it relative urls again (#5074) 2026-04-01 13:28:54 -07:00
ryan nguyen 41e47f94ed Revert "revert: restore S3 image URLs for documentation (#5063)" (#5065)
This reverts commit 7b418252f4.
2026-04-01 11:31:16 -07:00
Brandon McConnell 7b418252f4 revert: restore S3 image URLs for documentation (#5063)
* chore: reset files to state of commit 454825d

* Add assistant caller stats API endpoint (#5057)

Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

* Translate assistant caller stats endpoint into es, fr, zh (#5058)

Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-01 11:05:45 -07:00
Brandon McConnell edd4534bf4 fix: use github raw urls for image assets (temporary) (#5054)
* Revert "Replace S3 URLs with relative paths for theme and hero images (#5051)"

This reverts commit 43b3783e8c.

* fix: use GitHub raw URLs for image assets

Replace S3 bucket URLs with direct links to GitHub raw content for image assets. This provides a more consistent and reliable source for images used across the documentation pages.
2026-04-01 00:51:24 -07:00
mintlify[bot] 43b3783e8c Replace S3 URLs with relative paths for theme and hero images (#5051)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-01 00:14:46 -07:00
mintlify[bot] f8e015ff62 Improve SEO descriptions across 177 pages (#4993)
* Improve SEO metadata: update descriptions to 130-155 chars across 177 pages

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestions from code review

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>

* 💅

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-03-31 16:12:58 -07:00
mintlify[bot] 5d592f00af Document new data attributes for CSS targeting (#4779)
* Document data-active-deepest and Badge data attributes for CSS targeting

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-03-20 17:43:00 -07:00
mintlify[bot] 8972f8f2d0 Document data-active-deepest attribute for TOC items (#4777)
* Document data-active-deepest attribute for TOC items

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-03-20 17:39:33 -07:00
mintlify[bot] 1a78204a1e Add DropdownItem and MobileNavTabsBarItem to data-active docs (#4702)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-03-19 10:13:31 -07:00
mintlify[bot] 91f8b48c39 Document data-active attribute for active state CSS targeting (#4524)
* Document data-active attribute for TOC and sidebar items

Generated-By: mintlify-agent

* concision

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-03-17 10:36:42 -07:00
Ethan Palm 9d0640aafb Improve settings page IA and readability (#4446)
* settings overview page

* update docs.json

* update links in icons snippets

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* add schema reference

* add api settings

* add appearance settings

* add integrations settings

* add seo and search settings

* add structure

* add new contextual options

* update links

* Vale

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-13 16:17:34 -07:00
mintlify-development[bot] ad11bc265d Fix Vale style warnings: passive voice and punctuation (#4057)
* Fix Vale style warnings: passive voice and punctuation

- Convert passive voice to active voice in multiple component docs
- Fix quotation mark punctuation in navigation.mdx
- Update heading text to use correct casing
Style-only changes that don't affect content meaning.
Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-03-06 09:11:24 -08:00
mintlify[bot] dbdb1a298b Fix Vale style warnings across documentation (#4036)
* Fix Vale style warnings across documentation

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestions from code review

* Update guides/automate-agent.mdx

* Update integrations/analytics/adobe.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-03-05 10:11:54 -08:00
Ethan Palm 3dc3852b7a SEO descriptions (#4028)
* Improve SEO descriptions across 47 pages

Curated descriptions from two bot-generated PRs (#3908, #3949),
selecting the best approach for each page:
- Added missing title and description frontmatter to 10 API reference pages
- Benefit-focused descriptions for integration pages (not implementation-heavy)
- Accurate REST-aligned titles for API endpoints (Export, List, Trigger, etc.)
- Expanded short descriptions to 50–160 character range throughout

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* copyedit

* Update custom-domain.mdx

* Fix analytics API page titles to match spec summaries

"Export" was inaccurate — spec uses "Get" for both endpoints.
Also updated descriptions to use "Retrieve" for consistency.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 16:46:28 -08:00
mintlify[bot] 282b58c4c9 Update 404 error page documentation (#3804)
* Update customize/custom-404-page.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

* Update organize/settings.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-02-26 11:50:36 -08:00
Brandon McConnell 1cab61588a docs: add Luma theme documentation (#3749)
* docs: add Luma theme to docs

Updates various documentation sections to officially include the new Luma theme.
Adds Luma to the list of available themes and provides its description in relevant configuration and theme files.
Extends "frame" mode compatibility to include the Luma theme, reflecting its support for this layout.

* chore: losslessly compress images

used https://tinypng.com
2026-02-24 16:11:43 -08:00
mintlify[bot] 6268d03cc2 style: convert future tense to present tense (#3717)
* style: convert future tense 'will' to present tense across docs

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-02-24 12:05:49 -08:00
mintlify[bot] 845dc1ea80 Add all supported themes to keywords (#3718)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-02-24 11:50:08 -08:00
Ethan Palm a2361cfe59 use full s3 URLs for images (#3385) 2026-02-10 17:12:26 -08:00
Brandon McConnell b5ecc979eb Update docs to include "sequoia" as a theme (#3154)
* feat: update docs to include sequoia theme

* feat: add sequoia to themes list, replace all themes thumbnails

* feat: replace all themes thumbnails in localized themes pages
2026-02-10 16:52:56 -08:00
Dean from Mintlify eb9aa5b3f8 Clarify React component import limitations in MDX (#3105)
* Update customize/react-components.mdx

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

* Update customize/react-components.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-02-03 18:17:00 -08:00
Ethan Palm d2671c29a9 add layout shift warnings (#2856) 2026-01-25 15:32:18 -08:00
Kyle Finken 80384c69c1 Remove docs around snippets config (#2436)
We are refactoring the snippets solution this removes the documentation around that solution and refactors it
2025-12-18 13:56:15 -08:00
Ethan Palm c6eddf0158 Snippets v3 docs (#2363)
* add snippets prop

* update path info in React page

* update snippets page

* reviewer feedback
2025-12-16 18:56:56 -08:00
Han Wang 106ce41848 Update customize/custom-scripts.mdx (#2251)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-12-12 10:55:09 -08:00
Ethan Palm 7ff9692d3c remove screenshot (#2223) 2025-12-11 14:01:40 -08:00
mintlify[bot] b0015f732e Update customize/custom-scripts.mdx (#2174)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-12-10 11:28:54 -08:00
Ethan Palm dea3e55d41 Add info about dynamic 404 pages (#2124)
* add info about semantic links

* add more context
2025-12-08 14:10:43 -08:00
mintlify[bot] 8c0886aaf8 Clarify /docs subpath vs custom subpath setup (#1993)
* Update customize/custom-domain.mdx

* Update deploy/vercel.mdx

* Update deploy/cloudflare.mdx

* Update deploy/route53-cloudfront.mdx

* create overview for setting up /docs subpath

* add h3

* update vercel + move non-subpath content to new file

* correct Cloudflare page

* clean up AWS

* reviewer feedback

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-12-03 09:52:33 -08:00
Ethan Palm 6f0cf51504 Document support for .md (#1900)
* replace `MDX` with `Markdown` where appropriate

* favor MDX

* Emphasize .md is for migration, .mdx is recommended

* favor MDX

* missing words
2025-11-25 19:15:15 -08:00
Ethan Palm aa15340b6f Subpath terminology consistency (#1879)
* use `subdomain`

* use `subpath`

* use `subpath`
2025-11-25 13:47:38 -08:00
Ethan Palm 4c31f3683c SEO: add keywords to pages (#1775)
* ai/ keywords

* api/ keywords

* components/ keywords

* create/ keywords

* customize/ keywords

* api-playground/ keywords

* dashboard/ keywords

* deploy/ keywords

* guides/ keywords

* insights/ keywords

* integrations/ keywords

* optimize/ keywords

* organize/ keywords

* root/ keywords

* rm temp files
2025-11-14 14:08:24 -08:00
Ethan Palm 4b68a8e5ec Update descriptions for SEO (#1767)
* add global metatags

* set "indexing": "all"

* update AI group descriptions

* api-playground descriptions

* root level page descriptions

* component descriptions

* create descriptions

* customize descriptions

* dashboard descriptions

* deploy descriptions

* guides descriptions

* insights descriptions

* api-playground

* organize descriptions

* Integrations descriptions
2025-11-13 17:14:39 -08:00
mintlify[bot] c947ca0cd8 Resolve code snippet feedback (#1715)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-11-06 15:47:00 -08:00
mintlify[bot] 7fea2404d9 Update customize/custom-domain.mdx (#1673)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-10-30 15:53:16 -07:00
Ethan Palm 36b234fd85 Refresh custom domain docs (#1619)
* update DNS value

* update intro

* update images

* update Add your custom domain section

* update Configure your DNS section

* add DNS subsections

* update Cloudflare-specific info
2025-10-24 16:50:43 -07:00
mintlify[bot] e3178cfa6a Added canonical URL documentation to custom domain page (#1587)
* Update customize/custom-domain.mdx

* copy edit

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-10-20 13:56:15 -07:00
mintlify[bot] 0ce9aaa30a Add fonts configuration documentation (#1571)
* Update settings/fonts.mdx

* Update docs.json

* update fonts info in docs.json

* move fonts file

* copy edit

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-10-16 17:12:40 -07:00
mintlify[bot] 95a1051d65 Clarify React component import requirements (#1526)
* Update customize/react-components.mdx

* from -> into

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
2025-10-10 22:07:51 -07:00
Dean from Mintlify 8cc0515b58 Update custom-domain.mdx (#1472) 2025-10-06 16:19:40 -07:00
Kaishan (Sam) Ding 2e733a0754 fix broken links in themes (#1470) 2025-10-06 15:26:07 -07:00
Han Wang 182dc41482 Use frame instead of custom for pages 2025-10-05 15:31:38 -07:00
mintlify[bot] fc279667cc Fix typos in documentation (#1440)
* Update api-playground/overview.mdx

* Update customize/themes.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-10-03 12:46:08 -07:00
Ethan Palm 654d533b90 Task based IA (#1353)
* implement task-based IA

* rearrange pages

* tag examples

* add cookbook example

* add a components menu

* rename cookbook to guides

* fix docs.json after adding translations

* prettier docs.json

* move content to Guides

* move GEO page to guides

* draft of ai-native page

* update body with info on reading/distributing

* copy edits

* 💅

* move guides above API reference

* remove CLI sidebarTitle

* update organization

* remove tags

* remove guides icons

* Update ai-native.mdx

* Update ai-native.mdx

* copyedits

* 💅

* even number of cards

* update discovering section

* remove components tab

* remove icons

* remove icon

* add group level icons

* update Get started group

* Update organize group

* update customize group

* update create content group

* shorten URLs

* update API group

* update deploy group

* update optimize and guides groups

* set up redirects

* update links

* add pdf page

* add missing icons

* remove default expanded state

* update docs.json
2025-10-01 11:55:34 -07:00