Commit Graph

99 Commits

Author SHA1 Message Date
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
Ethan Palm b986025f82 Windsurf rule guide (#902)
* add windsurf guide to nav

* add windsurf guide

* remove cards

* add `:`
2025-07-10 11:55:07 -07:00
Ethan Palm ac7aa76d31 Update Cursor rule example (#885)
* update cursor rule

* update cursor rule

* formatting

* formatting

* update intro to rule example

* fix casing
2025-07-08 15:28:17 -07:00
Ethan Palm 614e25f0f0 Add Claude Code guide (#890)
* add Claude Code page

* add CLAUDE.md file

* revise CLAUDE.md

* different CLAUDE.md approach

* add info on using Claude Code to maintain docs

* remove node prereq since redundant with Mintlify

* 💅
2025-07-08 15:27:46 -07:00
Ethan Palm c8f48dec77 Analytics docs (#874)
* Create analytics.mdx

* add to `docs.json`

* add page content
2025-07-01 16:55:33 -07:00
Kathryn Isabelle Lawrence 163ddfa782 Add guide to changelogs + subscribable RSS feeds (#824)
* start changelogs guide

* start adding update component stuff

* Update `update` component page

* update `rss` info

* changelogs

* wrap code block

* update intro

* add dark mode ToC image

* update procedural sections

* update images

* fix dark mode image

* fix link

* add changelog in ctx menu screenshot

* light and dark mode images for ctx menu

* update changelog for test

* test

* update docs

* add xml example

* add upate example in feed

* rss in frontmatter not docs json

* update docs with frontmatter and image change

* update button images

* update images again

* copyedits

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-06-24 13:38:41 -07:00
Ethan Palm 7d3a74dca9 Hidden page example (#843)
* add hidden page

* add link to example hidden page

* make example page more informative

* add example to hidden page

* formatting

* copyedit
2025-06-23 12:08:46 -07:00
Ethan Palm 4b5adf1ab2 Assistant updates (#832)
* remove redundant link

* revise about section

* update assistant capabilities

* remove API filling

* replace redundant word

* reviewer feedback
2025-06-23 10:02:50 -07:00
Ethan Palm 11d10197bd update support links (#835) 2025-06-20 12:50:12 -07:00
Ethan Palm 2b150e5749 Change titles to sentence case (#833)
* change titles to sentence case

* make groups sentence case
2025-06-19 10:15:15 -07:00
Ethan Palm 8dcd5da760 Document the assistant (#812)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* fix parsing error

* update description

* copyedit about section

* update using the assistant section

* update ai ingestion section

* export/analysis section

* fix image

* add reviewer feedback

* clean up list

* make cards for ai ingestion section

* remove columns

* make sample prompts a card

* remove icons

* tidy formatting

* higher res images
2025-06-17 16:03:52 -07:00
Ethan Palm 75531ab8fe update hidden pages (#803) 2025-06-11 15:17:15 -07:00
Ricardo Nunez 40d2e2cd2d Add proper language support for syntax highlighting to all code blocks (#807)
* Add proper language support for syntax highlighting to all code blocks

* Camel case inline code
2025-06-11 12:38:15 -07:00
Ethan Palm 2f90de36dd Docs on manually triggering builds and previews (#784)
* Update preview deployment info

* add images

* 💅

* add deployments page

* add images

* update images

* add reviewer feedback

* polish
2025-06-10 17:16:43 -07:00
Ethan Palm 7cad13d410 note to not use trailing slash (#794) 2025-06-06 11:26:32 -07:00
Ethan Palm 0495a5a789 Add Cursor rules guide (#780)
* create new file for cursor guide

* add Cursor guide

* example formatting

* Update guides/cursor.mdx

* Update guides/cursor.mdx

* style nit

* add reviewer feedback

---------

Co-authored-by: tiffany-mintlify <tiffany@mintlify.com>
2025-06-04 13:59:12 -07:00
Ethan Palm 50e374b921 Update authentication and personalization docs (#761)
* rename "authentication vs personalization"

* Combine information into overview

* move files & configure redirects

* update page titles and docs.json

* add JWT info to auth setup

* add OAuth info

* add mintlify auth info

* add password info

* delete individual auth pages; configure redirects

* Update sending-data.mdx

* remove redundant info

* add JWT personalization info

* add shared session info

* delete individual personalization pages, add redirects

* Update partial-authentication-setup.mdx

* fix broken links

* overview copyedits

* setup copyedits

* copyedit sending data

* clarify hidden page language

* add reviewer feedback ✨

* emphasize hidden pages are not restricted
2025-05-30 13:47:53 -07:00
mintlify[bot] ce8492303a Update support email links to documentation support page (#745)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Update cloudflare.mdx

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* fixed additional links

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Dean from Mintlify <dean@mintlify.com>
2025-05-27 17:30:29 -07:00
Ethan Palm 804f56837c Add guide for monorepo setup (#735)
* add file for monorepo page

* add images

* we had screenshots already

* add monorepo guide

* clarify permissions

* typo
2025-05-27 08:51:20 -07:00
Kathryn Isabelle Lawrence e0c13adb36 How to add hidden pages (#655)
* add hidden pages hidden page

* update section on internal search

* add page to `docs.json`

* Apply suggestions from code review

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-05-20 18:18:27 -07:00
Han Wang 4b5a7dbb27 Update migration guides 2025-04-24 11:47:36 -07:00
Mayank Shouche b0776f491b Add guide for Auth0 OAuth handshake (#554)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* auth0 setup instructions

* revert unintended changes
2025-03-07 14:44:37 -08:00