Commit Graph

171 Commits

Author SHA1 Message Date
Ethan Palm 40f337909c Document new mint a11y flags (#2272)
* Update guides/accessibility.mdx

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

* Update installation.mdx

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

* Apply suggestions from code review

* Update guides/accessibility.mdx

* formatting

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-12-12 15:21:26 -08:00
Ethan Palm 625cac8233 Q&A bot updates (#2254)
* default Slack bot name

* reorder sidebar

* rename to Slack bot

* update links

* add link in assistant page

* Update docs.json
2025-12-12 11:28:39 -08:00
skeptrune 222fe874b4 fix: update API endpoint for assistant message integration (#2212) 2025-12-10 18:57:01 -08:00
Ethan Palm 2020d9b0a2 insights > analytics (#2210) 2025-12-10 18:02:18 -08:00
mintlify-development[bot] 0db6ae7c14 Add asDraft parameter to automation examples (#2094)
* Update guides/automate-agent.mdx

* Update guides/automate-agent.mdx

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2025-12-08 09:29:38 -08:00
Ethan Palm b6699b48c2 update procedure to access agent settings (#2083) 2025-12-05 16:19:31 -08:00
Ethan Palm d7e453d744 Knowledge base guide (#2039)
* add Use cases group

* Create knowledge-base.mdx

* add outline

* draft

* update guides overview

* update introduction

* update intro with assumption of migrating

* reorganize

* concision

* copyediting

* copyedits

* copyedit

* missing punctuation

* use Steps

* shorter heading
2025-12-03 19:55:58 -08:00
mintlify[bot] 287d71a8c2 Fix grammar issues in guides (#2017)
* Update guides/index.mdx

* Update guides/accessibility.mdx

* Update guides/media.mdx

* Update guides/style-and-tone.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-12-03 09:59:43 -08:00
mintlify[bot] e303bc939c Pull request for mintlify/docs-improvements-84149 (#1990)
* Update index.mdx

* Update quickstart.mdx

* Update guides/improving-docs.mdx

* Update guides/style-and-tone.mdx

* Update guides/content-types.mdx

* Apply suggestions from code review

* Update guides/style-and-tone.mdx

---------

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-02 10:25:54 -08:00
mintlify-development[bot] a551b3c3c0 Add guides overview page (#1950)
* Update guides/overview.mdx

* Update docs.json

* copyedits

* Update index.mdx

* update title

---------

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>
2025-12-01 11:21:43 -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
mintlify[bot] 5af2c01d4f Add Mintlify app installation requirement to automate-agent docs (#1871)
* Update guides/automate-agent.mdx

* Update guides/automate-agent.mdx

* copyedit

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-11-25 09:25:37 -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
Ethan Palm 0cbdf2e7e7 Embed assistant API guide (#1699)
* create guides

* add new pages to docs.json

* alphabetize sidebar nav

* add content for widget guide

* review code samples

* add content to deflection guide

* Update assistant-widget.mdx

* replace `domain` with `project`

* update reference

* update testing info

* copy edit

* 💅

* replace table with parafields

* concision

* use accordion for troubleshooting

* fix parameter names

* improve code sample

* remove deflection guide

no way to test right now

* improve UX of sample code

* tweak code sample

* simplify sample code

* rename guide

* edit intro

* update prerequisites

* use vite for consistency with sample code

* clarify `domain`

* copyedits

* set TODO:s

* simplify sample code

* update the verify steps

* Update assistant-embed.mdx

* add missing option

* review intro

* add preview button

* use steps

* move verify section

* fix text overflow

* fix links returned by assistant

* add more customization suggestions

* 💅 code sample

* note that example repo has some custommizations

* add link to repo

* update "What you will build"

* update prerequisites

* direct users to clone repo

* remove color and position customization

* remove troubleshooting

* update project structure section

* bugbot fixes

* add demo gif

* fix duplicate listener
2025-11-11 13:13:18 -08:00
Ethan Palm 00cf0f317a Add GitHub Action workflow to agent API guide (#1726)
* feature: created an ai generated ci action

* Add platform tabs

* readd Workflow overview

* active voice

* n8n prerequisites & fix heading levels

* 💅 n8n section

* 💅 GitHub Action section

* remove unused file

* review

* yaml indentation

* review yaml

* remove unused core and fetch

* remove IIFE wrapper

---------

Co-authored-by: cdxker <fdenzell@gmail.com>
2025-11-10 16:30:38 -08:00
Ethan Palm b0cbddc5d1 🧹 10-15 nits (#1560)
* add alt text

* fix broken link

* fix es/ broken links

* fix es/ broken links

* fix fr/ links

* fix zh/ links
2025-10-15 13:16:52 -07:00
Ethan Palm 4c90ec72c4 Migrate guide content (#1548)
* update sidebar title

* consolidate best practices group

* add understand your audience page

* add content types guide

* add navigation guide

* add style and tone guide

* add media guide

* add seo guide

* add maintenance guide

* add success content to "Improve your docs"

* update media title

* consistency
2025-10-14 16:20:42 -07:00
Ethan Palm a67fd112a0 Add guide on creating a n8n workflow to trigger agent API (#1538)
* add guide to nav

* draft of guide

* add monorepo note

* consolidate conceptual info

* copyedit

* copy edit

* add sidebar title

* alphabetize guides

* make steps use same language

* add images

* fix image path

* image sizing
2025-10-14 08:49:26 -07:00
Ethan Palm 3949543f6a Accessibility guide (#1511)
* add accessibility guide to nav

* draft of guide

* update intro

* update the what is accessibility section

* update alt text section

* update procedures

* Reorder sections
2025-10-09 16:35:44 -07:00
Ethan Palm 8a8e14a1ae Remove search page (#1505)
* remove search

* remove references to search

* alphabetize guides
2025-10-08 15:38:47 -07:00
Ethan Palm f26a93abc0 💅 2025-10-08 15:35:08 -07:00
mintlify[bot] 3dab7c7397 Rename Analytics to Insights throughout documentation (#1502)
* Update docs.json

* Update docs.json

* Update docs.json

* Update docs.json

* Update docs.json

* Update docs.json

* Update docs.json

* Update docs.json

* Update analytics/overview.mdx

* Update analytics/overview.mdx

* Update analytics/feedback.mdx

* Update analytics/search.mdx

* Update analytics/search.mdx

* Update guides/improving-docs.mdx

* Update guides/improving-docs.mdx

* Update docs.json

* Update docs.json

* copyedits

* Update docs.json

* rename directory

* fix dir name

---------

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-08 15:20:14 -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
mintlify[bot] 9b558c77e8 Add _mintlify/* to reverse proxy routing configuration (#1394)
* Update guides/reverse-proxy.mdx

* Update guides/reverse-proxy.mdx

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-09-29 12:59:30 -07:00
mintlify[bot] 25c44fecc6 Documentation edits made through Mintlify web editor (#1314)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-09-25 14:52:09 -07:00
Ethan Palm 020cd9dfea Resolve vale errors (#1270)
* don't lint inside curly brackets

* fix Vale errors

* false erroring on the word `information`
2025-09-24 14:38:35 -07:00
Ethan Palm 060ac1535b Fix vale errors (#1213)
* don't lint inside JSON examples

* actually don't lint inside JSON snippets

* update vocab

* fix errors

* update vocab

* remove latin abbreviations

* don't lint snippets

* update vocab

* don't lint in angle brackets

* add language tags

* update vocab

* regexify vocab list

* grammar
2025-09-19 17:28:26 -07:00
mintlify[bot] 7c71d9cd8e Added custom reverse proxy configurartion. (#1200)
* Update advanced/reverse-proxy.mdx

* Update docs.json

* Documentation edits made through Mintlify web editor

* Update advanced/reverse-proxy.mdx

* Update advanced/reverse-proxy.mdx

* Update advanced/reverse-proxy.mdx

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* move from `advanced` to `guides`

* copy edit

* remove Custom from title

* fix group casing

* concision

* update header

* replace lists with table

* more active language

* remove redundant example

* update placeholder

* remove propagating snippet

* copy edit troubleshooting

* make limitations more solutions-oriented

* update example config

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-09-19 09:23:04 -07:00
Ethan Palm c6b60fdf46 Add missing hostnames to CSP configuration (#1202)
* Add missing hostnames to CSP configuration

Added 13 missing domains found in comprehensive codebase search:
- *.mintlify.com (dashboard, API, analytics proxy)
- leaves.mintlify.com (GitLab webhooks)
- d1ctpt7j8wusba.cloudfront.net (mint releases)
- mintcdn.com (asset tracking)
- api.mintlifytrieve.com (search API)
- mintlify-assets.b-cdn.net (BunnyCDN)
- mintlify.s3-us-west-1.amazonaws.com (S3 images)
- fonts.googleapis.com (Google Fonts)
- cdn.jsdelivr.net (emoji assets)
- us.posthog.com (PostHog analytics)
- cdn.getkoala.com (Koala analytics)
- browser.sentry-cdn.com (Sentry error tracking)
- js.sentry-cdn.com (Sentry SDK)

Updated domain whitelist table and all CSP configuration examples
(Cloudflare, AWS CloudFront, Vercel) to include required domains.

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Apply suggestions from code review

Co-authored-by: Mayank Shouche <43075711+mayankshouche@users.noreply.github.com>

* Update guides/csp-configuration.mdx

Co-authored-by: Lucas <18381968+lucaspunz@users.noreply.github.com>

* Update guides/csp-configuration.mdx

* Update CSP examples to match revised domain whitelist

- Remove mintlify-assets.b-cdn.net and mintlify.s3-us-west-1.amazonaws.com
- Add *.mintcdn.com wildcard domain to img-src and connect-src
- Update all configuration examples (main, Cloudflare, AWS CloudFront, Vercel)
- Align with reviewer feedback from PR #1202

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* remove redundancies in examples

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Mayank Shouche <43075711+mayankshouche@users.noreply.github.com>
Co-authored-by: Lucas <18381968+lucaspunz@users.noreply.github.com>
2025-09-18 13:38:56 -07:00
RoyceWilliams510 dbf5ce2c2d removed quotes (#1203) 2025-09-18 12:49:46 -07:00
Ethan Palm 6cf4585e08 Feedback docs (#1080)
* update analytics intro

* update overview intro

* update feedback section

* update search intro

* create Analytics dashboard group

* create new analytics pages

* update docs.json with new pages

* delete guides/analytics

* update overview

* update search

* update improving docs

* add link to dashboard

* polish overview

* fix casing

* polish search

* update feedback

* consistency with other pages

* make improving docs more actionable

* polish improving docs
2025-09-16 14:42:23 -07:00
Ethan Palm 93301664ab Document site search (#1137)
* update site search functionality

* reviewer feedback

* make syntax more general

* 💅
2025-09-16 08:55:11 -07:00
Ethan Palm ace6b07c96 CSP configuration and whitelist domains (#1090)
* add CSP config page to docs.json

* Create csp-configuration.mdx

* update description

* add CSP header definitions

* update conceptual info

* combine testing/verification

* update troubleshooting

* use accordions for troubleshooting

* : isntead of -

* update whitelist table

* 💅

* style and concision

* simplify troubleshooting

* remove protocol

* remove protocol

* add `'unsafe-eval'`

* add blob in img-src

* make it more clear this is an edge case

* style

* update Cloudflare steps

* remove deprecated widget
2025-09-11 11:21:03 -07:00
Ethan Palm 4d57893332 Add assistant response handling information (#1093)
* add response handling information

* 💅

* Move beta note to just search

* use `Configure` to better match UI
2025-09-10 13:27:20 -07:00
Brandon Waselnuk e91d35084f updated docs to match new assistant open (#1083) 2025-09-05 06:31:19 -07:00
Ethan Palm dd5493431c Add assistant URL option (#1074)
* add assistant URL method

* 💅
2025-09-03 19:19:27 -07:00
Ethan Palm 4f6906f700 Assistant setup (#1073)
* update plan name

* add managing the assistant section

* add enable/disable info

* add info on message limits

* simplify managing the assistant section

* remove response handling
2025-09-03 18:02:33 -07:00
Ruhan Ponnada 286c45947b added docs on hidden groups (#1043) 2025-08-20 10:33:43 -07:00
Ethan Palm 1c504e28ea Revert "Adding a txt file for static hosting (#1034)" (#1035)
This reverts commit bad750858a.
2025-08-15 16:04:09 -07:00
Dean from Mintlify bad750858a Adding a txt file for static hosting (#1034)
* Create test.txt

* Create test.pdf

* updated the location of the files
2025-08-15 16:01:29 -07:00
Ethan Palm 298bd177c4 Migration guide update (#961)
* Update migration.mdx

* copyedit

* add section header

* update manual steps
2025-08-01 11:39:39 -07:00
Ethan Palm 71fc2188ed Deprecate growth tier (#934)
* remove growth tier

* tidier links

* update what's on pro plan

* add TODO:

* add TODO

* remove TODO:s

* remove unused snippet
2025-07-31 08:58:55 -07:00
Ethan Palm d193a3faa1 Add GEO guide (#957)
* create GEO guide

* copyedit

* remove redundancy

* add reviewer feedback
2025-07-25 11:22:34 -07:00
Ethan Palm 35f1ca8a46 add link to docs.json schema (#956) 2025-07-24 18:57:37 -07:00
Ethan Palm 6dbe1d1cd5 RSS changelogs v2 (#930)
* remove `rss` object from Update page

* update changelog info

* update example RSS feed
2025-07-22 11:58:57 -07:00
Ethan Palm 4143274062 how to enable feedback (#936) 2025-07-22 11:27:10 -07:00
Ethan Palm 573eaa503d Create AI optimization group (#920)
* update `docs.json`

* add snippet

* update nav

* add llms.txt page

* update assistant title

* add contextual menu page

* add markdown export page

* remove ai-ingestion page

* reviewer feedback
2025-07-16 17:22:11 -07:00
Ethan Palm 3a37747f1b Content refresh (#910)
* Update Quickstart page for style and clarity

- Improve readability and flow
- Make language more concise and consistent
- Remove unnecessary periods from numbered lists
- Clarify instructions and terminology

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Expandables component page

- Add clear introduction explaining the component's purpose
- Remove unnecessary period from description
- Improve formatting consistency for boolean values
- Enhance clarity in prop descriptions

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Fields component page

- Add clear introduction explaining field components
- Improve consistency in component naming conventions
- Remove unnecessary periods from descriptions
- Improve punctuation and clarity
- Add comma for better readability in example

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Icons component page

- Add clear introduction explaining the Icon component
- Improve language clarity and flow
- Remove unnecessary periods from prop descriptions
- Replace 'e.g.' with 'for example' for consistency
- Remove trailing space from inline example

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Mermaid diagrams page

- Add clear introduction explaining Mermaid's purpose and capabilities
- Improve clarity and conciseness of descriptions
- Simplify section heading from 'Syntax for Mermaid diagrams' to 'Syntax'
- Make language more precise and user-focused
- Update code comment to be more generic

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Steps component page

- Add clear introduction explaining the Steps component
- Improve language clarity and consistency
- Remove unnecessary periods from prop descriptions
- Add Oxford comma for better readability
- Make description more action-oriented

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Tabs component page

- Add clear introduction explaining the Tabs component purpose
- Improve clarity and user understanding
- Remove unnecessary period from prop description
- Make description more informative about component functionality

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Migrations guide page

- Improve language clarity and conciseness
- Remove unnecessary periods from command descriptions
- Enhance section structure with proper headings
- Update terminology for consistency
- Add OpenAPI migration section header for better organization

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update React components page

- Improve language clarity and conciseness throughout
- Simplify and tighten explanatory text
- Fix capitalization in performance best practices
- Remove redundant phrases for better flow
- Enhance readability and user experience

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Redirects and broken links page

- Improve language clarity and conciseness
- Remove unnecessary words like 'Simply' and 'will'
- Use present tense for more direct communication
- Fix preposition usage for better grammar
- Streamline explanations for better readability

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update Support integrations page

- Improve language clarity and directness
- Remove unnecessary words for better flow
- Use more direct phrasing for instructions
- Simplify conditional language for better readability

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Update CI checks page

- Improve language clarity and conciseness throughout
- Remove unnecessary words and phrases
- Use present tense for more direct communication
- Fix grammar issues and improve flow
- Replace 'in-built' with 'built-in' for standard terminology
- Streamline explanations for better readability

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* quickstart edits

* Update cards

* Apply style lessons learned from quickstart and cards feedback

- Use action-oriented introductions ("Use X to..." instead of "The X component...")
- Apply sentence case to all section headings ("Properties" not "Props")
- Use "Properties" consistently instead of "Props"
- Remove unnecessary periods from property descriptions
- Update component headings to sentence case
- Make language more direct and user-focused

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* fix typo

* review exapandables

* update fields

* update icons

* update mermaid

* update steps

* update tabs

* update migration

* Update react-components.mdx

* Update broken-links.mdx

* Update overview.mdx

* Update ci.mdx

* Document style preferences learned from content refresh project

Add detailed style guide based on patterns identified during DOC-84
content refresh work, including:
- Heading and formatting conventions
- Component introduction patterns
- Property description standards
- Language and tone preferences
- Code example best practices
- Content organization principles

These learnings will help maintain consistency in future documentation updates.

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* add reviewer feedback

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-07-15 16:59:47 -07:00
Ethan Palm 620083bf14 remove model selection (#897) 2025-07-14 15:08:06 -07:00