Commit Graph

71 Commits

Author SHA1 Message Date
mintlify[bot] 7ca5d781f9 Document new headline prop for Tooltip component (#2271)
* Update components/tooltips.mdx

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

* Update components/tooltips.mdx

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

* 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-12-12 17:51:42 -08:00
Ethan Palm 100689f9d5 RSS changelog information (#2274)
* add RSS info to update component

* update changelog RSS info
2025-12-12 15:40:32 -08:00
Ethan Palm a3d8859cc9 add alt text to tiles page (#2236) 2025-12-11 17:30:45 -08:00
Ethan Palm 8eeb788c07 fix indent in example (#2135) 2025-12-08 18:46:30 -08:00
mintlify[bot] 9571a27c7d Add table of contents behavior documentation to View component (#2121)
* Update components/view.mdx

* Update components/view.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-08 12:22:18 -08:00
Ethan Palm 47e292bccd Add tip on using view component (#2007)
* Clarify that view component should be used once per page.

Customers were creating multiple view components on the same page, causing duplicate menu items. The component is designed to be used once per page since the multi-view dropdown is shared across the entire page.

🤖 Generated with Claude Code

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

* add tip

---------

Co-authored-by: Claude <noreply@anthropic.com>
2025-12-02 13:32:32 -08:00
mintlify[bot] 2afd78c84a Add documentation for Tile component (#1971)
* Update components/tiles.mdx

* Update docs.json

* update examples

* Apply suggestions from code review

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: pqoqubbw <pqoqubbw@gmail.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-12-01 23:59:22 +01:00
mintlify[bot] bada351e85 Add documentation for Color component (#1880)
* Update components/color.mdx

* Update docs.json

* add keywords

---------

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-26 01:50:36 +01:00
mintlify[bot] 7dc99765c2 Add documentation for Frame component hint prop (#1842)
* Update components/frames.mdx

* Update components/frames.mdx

* Update components/frames.mdx

* Update components/frames.mdx

* Update components/frames.mdx

* Update components/frames.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-21 17:11:18 -08:00
Han Wang 2daeccaf55 Update icon again 2025-11-17 20:44:45 -08:00
Han Wang 5c5e3a64c3 Update card 2025-11-17 20:43:03 -08:00
mintlify[bot] ad5828f14c Add Badge component documentation (#1779)
* Update components/badge.mdx

* Update docs.json

* Update components/badge.mdx

* Update components/badge.mdx

* Update components/badge.mdx

* Update components/badge.mdx

* Update components/badge.mdx

* Update components/badge.mdx

* nits

* Update components/badge.mdx

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: pqoqubbw <pqoqubbw@gmail.com>
Co-authored-by: dmytro <71014515+pqoqubbw@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-11-15 00:26:00 +01: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] db474dc93b Update components/icons.mdx (#1753)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-11-13 21:37:46 +01:00
Han Wang df9c2c996d Update columns copy 2025-11-11 17:22:41 -08:00
mintlify[bot] 54c3704dcb Add View component documentation (#1702)
* Update create/text.mdx

* Update components/view.mdx

* Update docs.json

* Update docs.json

* Update docs.json

* Update docs.json

* Update create/text.mdx

* Update components/view.mdx

* Update components/view.mdx

* Update docs.json

* Update components/view.mdx

* Update components/view.mdx

* Update docs.json

* Update docs.json

* Update components/view.mdx

Co-authored-by: Kaishan (Sam) Ding <52273168+dks333@users.noreply.github.com>

* Update components/view.mdx

Co-authored-by: Kaishan (Sam) Ding <52273168+dks333@users.noreply.github.com>

* fix issues

* remove <CodeGroup />

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: dmytro <71014515+pqoqubbw@users.noreply.github.com>
Co-authored-by: Kaishan (Sam) Ding <52273168+dks333@users.noreply.github.com>
Co-authored-by: pqoqubbw <pqoqubbw@gmail.com>
2025-11-11 18:37:05 +01: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
Ethan Palm 9febbdc391 add banner color control (#1583) 2025-10-20 10:40:10 -07:00
Ethan Palm 4149a52a3b add alt text (#1442) 2025-10-03 13:07:36 -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
Ethan Palm 1e4b830015 Add styling.codeblocks docs (#1396)
* add styling.codeblocks docs

* reviewer feedback

Co-authored-by: Kathryn Isabelle Lawrence <lawr3ka@gmail.com>

---------

Co-authored-by: Kathryn Isabelle Lawrence <lawr3ka@gmail.com>
2025-09-30 13:38:19 -07:00
mintlify[bot] bfa3804127 Add supported file extensions to Files component documentation (#1402)
* Update components/files.mdx

* Update components/files.mdx

* Update components/files.mdx

* Update components/files.mdx

* Update components/files.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-09-30 11:40:01 -07:00
Ruhan Ponnada 6a0bde503e Revert "Updated codeblock styling documentation with new theme options (#1252)" (#1344)
This reverts commit bad67622c0.
2025-09-26 10:51:32 -07:00
Ethan Palm 7229a0d7c3 Add files page (#1267)
* move static assets info to new page

* add new page to nav

* edit and add file size limits
2025-09-24 12:56:56 -07:00
mintlify[bot] bad67622c0 Updated codeblock styling documentation with new theme options (#1252)
* Update settings.mdx

* Update code.mdx

* Update components/code-groups.mdx

* Update settings.mdx

* Update code.mdx

* Update components/code-groups.mdx

* Update settings.mdx

* Update code.mdx

* Update components/code-groups.mdx

* copy edits

---------

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-23 19:30:13 -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
Ethan Palm f283e5a790 add example request/response examples (#1120) 2025-09-11 15:13:24 -07:00
mintlify[bot] 3766296678 Streamline banner component documentation (#1104)
* Update components/banner.mdx

* add to docs.json

* update frontmatter

* copy edit banners

* update description

---------

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-10 16:33:38 -07:00
mintlify[bot] b9363c3d04 Pull Request: Remove RequestExample wrappers from component pages (#1105)
* Update components/columns.mdx

* Update components/frames.mdx

* Update components/mermaid-diagrams.mdx

* Update components/tooltips.mdx

* copy edit columns

* Replace lorem ipsum with example text

* update frames page

* Update mermaid-diagrams.mdx

* copy edit tooltips

* update tooltips

---------

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-10 13:23:55 -07:00
Ruhan Ponnada d3d4b616b1 callout wrap (#1081) 2025-09-05 08:50:38 -07:00
Ruhan Ponnada 9e456fcb6a added new tooltip props and callout component (#1075)
* added new tooltip props and callout component

* add danger

* put example inline

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-09-04 15:00:11 -07:00
Dean from Mintlify 1aaae5f9bf Update accordions.mdx (#971)
* Update accordions.mdx

* add snippet for icons

* use icon snippet for consistency

* add required/optional icon snippets

* update for required/optional

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-08-05 09:22:48 -07:00
Michael Cho 26d75e937d Updates the type of "default" in ParamField to be "any" (#976) 2025-07-30 17:29:21 -07:00
Michael Cho 303c2f8581 Remove initialValue and edit description of default in ParamField (#916)
* Change mentions of introduction.mdx to index.mdx

* Remove initial value and edit description of default
2025-07-28 16:46:04 -07:00
Ethan Palm 20a8e666bd update accordion page (#941) 2025-07-22 20:05:27 -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 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
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 29930810d5 update examples page (#879) 2025-07-10 17:16:22 -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
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 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 77dbbe357c Update icons docs (#818)
* 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 formatting
2025-06-13 14:53:41 -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
Kaishan (Sam) Ding 77bdb0d1bd add danger callout (#789) 2025-06-05 13:13:21 -07:00
Ethan Palm 63d2c68002 Update support content (#767)
* move github troubleshooting info

* remove duplicate API troubleshooting info

* move SVG info to cards page

* move `/api` 404 info to navigation

* move and rename support

* update support info

* copyedits

* fix wording

* typo fix
2025-05-30 11:51:21 -07:00
Ethan Palm 7577bb70b7 link cards to columns (#724) 2025-05-23 08:39:22 -07:00
Ethan Palm c3be25c633 Fix typo (#698) 2025-05-12 17:06:30 -07:00