Commit Graph

128 Commits

Author SHA1 Message Date
Ethan Palm 6bb14aa061 docs: replace dashboard.mintlify.com with app.mintlify.com (#5990)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-26 15:42:09 -07:00
mintlify[bot] f14cca3b52 Standardize style and tone across docs (#5652)
* Standardize style: 'Click' to 'Select' for Mintlify UI; split long sentences

Generated-By: mintlify-agent

* Revert 'select' back to 'click' for UI interactions

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

* Fix select→click for UI elements across docs

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-05-08 15:34:08 -07:00
skeptrune 9200586a3a Boost search ranking for single-word title pages (#5670)
* docs: boost search ranking for single-word title pages

Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first.

* docs: drop boost on websocket-playground stub to keep canonical Playground ranking

`api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
2026-05-05 10:30:58 -07:00
Kaishan (Sam) Ding 40947f0ea9 fix (#5635) 2026-05-01 14:06:08 -07:00
Ethan Palm 490436fda9 use snippet for repeated prompt (#5628) 2026-05-01 11:29:29 -07:00
mintlify[bot] c33a91e87f Update quickstart and AI docs (#5614)
Mintlify-Source: dashboard-editor

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-30 14:47:01 -07:00
mintlify[bot] 1b8c6673fb docs: remove auto-generate callout from quickstart (#5591)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-04-28 22:33:45 -07:00
mintlify[bot] 11cf5370de Update GitHub docs for Git setup wizard (#5417)
* Update GitHub docs to reflect the new Git setup wizard

Generated-By: mintlify-agent

* add gitlab updates

* Update quickstart.mdx

* Update github.mdx

* caution

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2026-04-16 14:41:33 -07:00
Ethan Palm 67af10ce48 fix links (#5370) 2026-04-14 17:47:25 -07:00
Ethan Palm db3ca0500d CLI updates (#5150)
* update skills

* update migration guide

* update API migration guide

* update assistant page

* update analytics page

* update CLI commands

* deprecate openapi-check

* add coming soon

* update docs.json

* add index page

* add install page

* add preview page

* add analytics

* add commands reference

* update links

* delete installation.mdx

* add optional prereq steps

* Add telemetry section to commands reference

Incorporates telemetry content from #5039 which was merged to main after
this branch was created. Documents opt-out flags, env variables, and
config persistence.

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

* move global flags to top

* vale

* remove `mint upgrade`

* remove unnecessary prereq

* restructure analytics commands

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-06 10:40:51 -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
Ethan Palm 4a6281825b Auto-generate docs sites (#3938)
* vale

* add new page to nav

* add tip to quickstart

* add auto-generate page

* add to migration guide

* add languages for codeblocks

* copyedits

* 💅

* update quickstart link

* remove auto-generate page

* add example to tip

* vale
2026-03-03 09:40:33 -08:00
mintlify[bot] e9da369dff Fix Vale style warnings: future tense to present tense (#3823)
* Fix Vale style warnings: replace future tense with present tense

Generated-By: mintlify-agent

* 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-26 16:39:36 -08:00
mintlify[bot] 2225cc12ec Add Prompt component documentation (#3393)
* Update components/prompt.mdx

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

* Update components/index.mdx

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

* copy edit

* consolidate examples

* add prompt to quickstart

* use prompt for the description

* give agents MD

* add prompt to nav

---------

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-11 16:52:37 -08:00
Ethan Palm 662afd5b28 Update Mintlify skill (#3317)
* create Mintlify docs skill

* move URL

* add step to load product knowledge

* remove redundancy with default skill.md

* consolidate into default skill.md

* add tip to quickstart
2026-02-09 12:59:57 -08:00
dks333 6b2b8fbc2a Revert "Refactor documentation structure and content (#3281)"
This reverts commit 159232d90d.
2026-02-08 19:39:32 -08:00
dks333 ff4bdac782 Revert "Update quickstart guide"
This reverts commit a02e9f9e17.
2026-02-08 19:39:28 -08:00
mintlify-development[bot] a02e9f9e17 Update quickstart guide 2026-02-09 03:26:52 +00:00
mintlify-development[bot] 159232d90d Refactor documentation structure and content (#3281)
Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2026-02-09 03:22:14 +00:00
Han Wang 6cbb1c9d87 Testing again (#3248)
* Update quickstart guide

* Update quickstart guide

* Update quickstart guide

* Update quickstart guide

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2026-02-08 20:15:07 +00:00
mintlify-development[bot] aecd9721a6 Fix broken API links and improve keyword coverage (#3251)
* Fix broken links and improve keyword coverage

- Fix API reference links using incorrect /api-reference/ path (should be /api/)
- Add missing period to agent API link
- Add relevant keywords to installation and deployments pages
- Specify Node.js version in troubleshooting section

* Apply suggestion from @tembo[bot]

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

---------

Co-authored-by: Mintlify Agent <agent@mintlify.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: tembo[bot] <208362400+tembo[bot]@users.noreply.github.com>
2026-02-08 09:53:59 -08:00
Han Wang 889a825cfd Update quickstart and settings documentation (#3246)
* Update quickstart and settings documentation

* Update organize/settings.mdx content

* Update quickstart and settings documentation

* Update settings documentation

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2026-02-08 03:53:03 +00:00
Ethan Palm 3974d12fd8 remove mention of frontmatter in web editor (#2983) 2026-01-30 09:35:51 -08:00
mintlify[bot] b07a3ee82b Add SEO keywords to quickstart (#2940)
* Update quickstart.mdx

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

* Apply suggestion from @tembo[bot]

Co-authored-by: tembo[bot] <208362400+tembo[bot]@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>
Co-authored-by: tembo[bot] <208362400+tembo[bot]@users.noreply.github.com>
2026-01-28 13:30:55 -08:00
dmytro 02905e693c fix: remove Columns wrapper for the next steps (#2621) 2026-01-09 17:31:21 +01:00
Han Wang ccc30217b5 undo relative pages for french relative page 2025-12-30 22:05:44 -06:00
Han Wang 2f192163fd Test for local files 2025-12-30 21:57:10 -06:00
Ethan Palm e175258025 Mintlify Docs Edits (#2514)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor
2025-12-28 21:49:24 -08:00
Ethan Palm f33c9dd8b7 Editor docs (#2490)
* create files and update docs.json

* draft of overview

* keyboard shortcuts draft

* draft of publishing

* draft of collaborate

* configurations draft

* media draft

* content draft

* navigation draft

* edit shortcuts

* update overview

* update media page and add images

* collaborate edits

* reorder nav

* publish edits

* copy edit publish

* publish 💅

* remove redundancy

* demo commit

* fix tooltips

* make configurations focused on tasks

* update index

* rename content.mdx to pages.mdx

* copy edit pages

* make configuration section more task-based

* 💅 pages

* remove old editor page

* add redirect

* 💅 navigation

* add more nav elements

* fix tooltip

* update numbering

* update redirects

* update links

* fix redirect loop

* remove columns
2025-12-22 19:06:24 -08:00
Ethan Palm 052669129e stack cards (#2488) 2025-12-22 13:56:18 -08:00
Ethan Palm 7e355e9276 Re-add CLI instructions to quickstart (#2485)
* add CLI instructions to quickstart

* one path

* polish up
2025-12-22 13:17:30 -08:00
Ethan Palm 7c4f314298 Onboarding updates (#2336)
* add local preview page

* clarify when someone needs the GitHub app

* add local preview prereq

* add CLI prerequisites

* add more context on Git

* update details about GitHub App for mintlify-community repos

* update branch information

* simplify quickstart

* add links to local setup guide

* add local-setup to nav

* add local setup page

* 💅

* consistent naming for web editor

* make migrations title more connected to onboarding

* make "Get started" group more focused

* combine local setup into CLI page

* fix editor step

* link to CLI in quickstart next steps

* quickstart 💅

* github 💅

* remove preview-locally page

* guides 💅

* copyedits

* cli 💅

* remove passive voice
2025-12-16 15:19:32 -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
Ethan Palm 66faccbf93 Documentation edits made through Mintlify web editor (#1864)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-11-24 16:22:50 -08:00
Han Wang 9e1a2bad7c Remove hello world 2025-11-17 09:04:16 -08:00
Han Wang 07725e354e Merge branch 'main' of https://github.com/mintlify/docs 2025-11-17 09:03:59 -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
Han Wang 4ba4096a38 Update docs 2025-11-12 10:32:06 -08:00
mintlify[bot] bb697ff30e Update quickstart.mdx (#1737)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-11-11 17:45:48 -08:00
Ethan Palm fa736f7d54 Document mint new command (#1679)
* consolidate preview information

* add `mint new` info

* shorter heading

* update quickstart
2025-11-04 10:22:55 -08: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
Ethan Palm 36b871da45 Add Node.js version requirement for CLI (#1581)
* clean up headers

* add node version prerequisite to installation

* add intro for CLI

* add node version to quickstart
2025-10-20 09:49:26 -07:00
Ethan Palm 360346dab8 fix links (#1562) 2025-10-15 13:52:30 -07:00
mintlify-development[bot] 521397509f Fix spelling and grammar issues in documentation (#1434)
* Update quickstart.mdx

* Update api-playground/overview.mdx

* Update organize/navigation.mdx

---------

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-10-06 09:08:13 -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 e52b7ab979 replace link (#1102) 2025-09-10 10:50:24 -07:00
Kathryn Isabelle Lawrence 14b4c6c56b Add pnpm back to CLI docs (#939)
* add code group with pnpm back

* add pnpm add commands

---------

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-07-22 14:58:53 -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
Michael Cho 5929714645 Change mentions of introduction.mdx to index.mdx (#868) 2025-06-27 10:42:16 -07:00