Commit Graph

1068 Commits

Author SHA1 Message Date
mintlify[bot] 46b529d5e8 Documentation edits made through Mintlify web editor 2025-11-13 20:19:09 +00:00
Ethan Palm 5bb60b145f logo direct to docs homepage (#922) 2025-07-17 10:12:59 -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 82605179c5 Tabs support icons (#919)
* add icon info to tabs page

* add icons to tabs example

* update allowed icon type
2025-07-16 14:50:22 -07:00
skeptrune 87ea644422 fix: layout shift on introduction page for docs (#917) 2025-07-16 11:03:34 -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 be72beb8d4 Document assistant API limits (#914)
* update intro

* add limits

* remove example using old API

* reviewer feedback
2025-07-15 11:23:05 -07:00
Dean from Mintlify d13bfd9b80 fixing the import codeblock (#915)
Aw yeah
2025-07-15 10:53:54 -07:00
Ethan Palm 9e33c21779 Update speakeasy integration guide (#913)
* update content

* add image files

* add frames
2025-07-15 09:38:19 -07:00
skeptrune cdca393da1 nick/fix assistant api url (#912)
* Refactor API endpoint to generate assistant messages with updated request and response structures

* Add Mintlify documentation and update API reference for assistant message generation

* Update OpenAPI specification for assistant message generation with new request structure and additional properties

* Add default values for threadId and messages in assistant message generation

* Add back the create topic and generate message pages

* fix: correct the openapi url for assistant
2025-07-14 17:23:02 -07:00
Ethan Palm 620083bf14 remove model selection (#897) 2025-07-14 15:08:06 -07:00
Ethan Palm 8cb398e8f6 Add webhooks section to OpenAPI setup (#894)
* add webhooks section

* put version requirements in context
2025-07-14 10:28:16 -07:00
skeptrune 3eb582f5b8 #3707 Refactor API endpoint to generate assistant messages with updated request and response structures (#905)
* Refactor API endpoint to generate assistant messages with updated request and response structures

* Add Mintlify documentation and update API reference for assistant message generation

* Update OpenAPI specification for assistant message generation with new request structure and additional properties

* Add default values for threadId and messages in assistant message generation

* Add back the create topic and generate message pages
2025-07-11 16:44:51 -07:00
Ethan Palm 91b02b70cf Add aspen to themes (#867)
* add aspen to themes

* added images

* added images to the repo

---------

Co-authored-by: Ruhan <ruponnada@gmail.com>
2025-07-11 14:32:19 -07:00
Ethan Palm 29930810d5 update examples page (#879) 2025-07-10 17:16:22 -07:00
Ethan Palm 2fd86b3b82 copyedit lists-tables (#877) 2025-07-10 17:15:28 -07:00
Ethan Palm a7320785a6 Update Pages article (#876)
* update Pages

* fix code sample
2025-07-10 17:14:33 -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
Kaishan (Sam) Ding 1282bd1a76 add perplexity in contextual menu (#904)
* add perplexity in contextual menu

* remove formatting
2025-07-10 11:35:32 -07:00
Ethan Palm fbdaafc501 Deprecate translations (#900)
* Delete translations.mdx

* remove translations from nav

* remove links to translations
2025-07-10 09:10:45 -07:00
Ethan Palm 8597fa9fa8 Add writing guidelines for examples and context (#896)
- Use broadly applicable examples rather than overly specific business cases
- Lead with context when helpful - explain what something is before diving into implementation details

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

Co-authored-by: Claude <noreply@anthropic.com>
2025-07-09 15:06:21 -07:00
Kaishan (Sam) Ding ea95f44f35 add language dropdown example (#895)
* add language dropdown example

* copyedit

* bring changes from #878

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-07-09 14:28:21 -07:00
Kaishan (Sam) Ding 9c17a781a8 Code group language dropdown (#893)
* add code group dropdowns

* fix the title

* reviewer edits

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-07-09 13:56:27 -07:00
Kaishan (Sam) Ding 4a2308e5cb add custom option in context menu (#892)
* add custom option in context menu

* review edits

* fix link

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-07-09 11:31:06 -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 55f5ed205c Specify page-level playground settings (#889)
* Claude Code's commit

* edit page-level playground info
2025-07-08 13:39:56 -07:00
mintlify[bot] b8d969913e Add Enterprise plan availability note to RBAC documentation (#888)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-07-08 10:34:44 -07:00
Ethan Palm 1104e80759 Update provider-specific info in custom domain docs (#886)
* add provider-specific settings section

* use accordions
2025-07-07 16:54:27 -07:00
Ethan Palm 7393a7f54b Update information about fonts (#880)
* specify Inter is default font

* google fonts load automatically
2025-07-03 16:57:05 -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
Ethan Palm 1912ba56f6 Fix broken link in API Playground troubleshooting page (#873)
* fix broken link

* copyedit
2025-06-30 15:54:11 -07:00
Ethan Palm c0d0a41a01 remove new tag (#870) 2025-06-30 10:29:51 -07:00
Michael Cho 5929714645 Change mentions of introduction.mdx to index.mdx (#868) 2025-06-27 10:42:16 -07:00
Ethan Palm 922620bacc Update images and embeds (#863)
* update page

* add info on styling with CSS

* move styling info to Custom scripts
2025-06-27 10:08:18 -07:00
Kaishan (Sam) Ding 0cde3a9323 fix: showFullScreen should be camelcased (#866) 2025-06-27 09:07:53 -07:00
Kathryn Isabelle Lawrence e0e665074f CLI docs update (#862)
* update cli docs

* remove CodeGroup tags

* format troubleshooting steps

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-06-26 14:28:29 -07:00
Kaishan (Sam) Ding 2fcf753833 add diff in code block (#823)
* add diff in code block

* Update code.mdx

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

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-06-26 14:05:33 -07:00
Ethan Palm 0406ff0cb0 Testing cursor rule (#858)
* testing cursor rule

* update frontmatter

* update headers and text formatting sections

* update links section

note: Cursor made up a CLI command

* remove callout from links

* blockquotes and math

* line breaks

* best practices

* fix link

* reviewer feedback
2025-06-26 13:51:35 -07:00
Ethan Palm f9f11f62b5 Add thumbnail configuration (#861)
* add thumbnail configuration

* pages should be single lines

* Revert "pages should be single lines"

This reverts commit 8cadd059da.
2025-06-26 09:15:00 -07:00
Kaishan (Sam) Ding df2c8f0462 fix thumbnails (#859)
* fix thumbnails

* thumnails
2025-06-25 18:23:45 -07:00
Han Wang 99eb7f8598 Add thumbnail background 2025-06-25 17:59:04 -07:00
Ethan Palm 83e9664444 add cursor rule (#857) 2025-06-25 16:13:06 -07:00
Ethan Palm cb7180b5a0 add undocumented events (#856) 2025-06-25 14:36:35 -07:00
Kaishan (Sam) Ding 821de9da17 feat: support .jsx files (#854)
* support jsx files

* add .jsx

* Apply suggestions from code review

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-06-25 13:16:32 -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 4f8a23529c Add notes with DNS propagation details (#850)
* update snippets

* add notes about DNS propagation
2025-06-24 11:27:07 -07:00
mintlify[bot] 959b551db3 Update CLI installation page title from "CLI" to "CLI installation" (#849)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-06-24 08:24:55 -07:00
Hahnbee Lee 46d45b8a95 add auth keyword to auth pages (#841)
* add auth keyword to auth pages

* undo format
2025-06-23 12:39:44 -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