skills/mintlify__docs
1
0
Fork 0
mirror of https://github.com/mintlify/docs.git synced 2026-09-14 13:35:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
2,354 Commits 1,654 Branches 0 Tags
docs-diff-syntax-1772836707
Commit Graph

107 Commits

Author SHA1 Message Date
mintlify[bot] 5c9689a8f6 Add external translation provider workflow guide (#3461) 
* Add external translation provider workflow guide

* Fix passive voice on line 320

* Fix shell issues in external translation workflow examples

- Preserve directory structure in export package using mkdir -p + relative path
- Quote \$lang variable in find command

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

* Add zh to supported language codes list

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

* formatting

---------

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-03-06 10:02:09 -08:00
mintlify[bot] dbdb1a298b Fix Vale style warnings across documentation (#4036) 
* Fix Vale style warnings across documentation

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestions from code review

* Update guides/automate-agent.mdx

* Update integrations/analytics/adobe.mdx

---------

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-05 10:11:54 -08:00
Ethan Palm 3dc3852b7a SEO descriptions (#4028) 
* Improve SEO descriptions across 47 pages

Curated descriptions from two bot-generated PRs (#3908, #3949),
selecting the best approach for each page:
- Added missing title and description frontmatter to 10 API reference pages
- Benefit-focused descriptions for integration pages (not implementation-heavy)
- Accurate REST-aligned titles for API endpoints (Export, List, Trigger, etc.)
- Expanded short descriptions to 50–160 character range throughout

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

* copyedit

* Update custom-domain.mdx

* Fix analytics API page titles to match spec summaries

"Export" was inaccurate — spec uses "Get" for both endpoints.
Also updated descriptions to use "Retrieve" for consistency.

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

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
 2026-03-04 16:46:28 -08:00
mintlify[bot] 7d668e8901 Add headless terminology to custom frontend page (#3965) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-03 10:34:52 -08:00
mintlify[bot] fd35f7ebb4 Fix Vale style: move period inside quotation marks (#3958) 
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-03 10:05:59 -08:00
mintlify[bot] 58f2edce8e Fix Vale style issues in ai-native and knowledge-base pages (#3917) 
- Hyphenate 'up-to-date' when used as adjective before noun (ai-native.mdx)
- Replace 'file path' with 'path' per WordList rule (knowledge-base.mdx)
Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-03-02 14:15:37 -08:00
Ethan Palm 8a48c99b8b Sunset suggestions (#3883) 
* remove and redirect suggestions from docs.json

* Update ai-native.mdx

* update links

* deprecate suggestions

* cleanup

* move content from removed pages
 2026-02-27 18:00: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-development[bot] 0b7ed42ab7 Fix Vale style violations: replace 'functionality' with preferred terms (#3770) 
* Fix Vale style violations: replace 'functionality' with preferred alternatives

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

---------

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>
 2026-02-25 13:02:03 -08:00
mintlify[bot] 6268d03cc2 style: convert future tense to present tense (#3717) 
* style: convert future tense 'will' to present tense across docs

Generated-By: mintlify-agent

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* Apply suggestion from @ethanpalm

* 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-24 12:05:49 -08:00
mintlify[bot] 0dffda57f9 Fix Vale style violations (#3641) 
- Changed 'file names' to 'filenames' per WordList rule
- Changed 'vs.' to 'versus' per WordList rule

Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-02-23 10:50:23 -08:00
mintlify[bot] 80e1e20c07 Fix Vale style violations (#3573) 
- Remove exclamation point in hidden-page-example.mdx
- Replace 'click on' with 'click' in google-analytics.mdx
- Replace 'open-source' with 'open source' in maintenance.mdx

Generated-By: mintlify-agent

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-02-20 09:14:12 -08:00
Ethan Palm 29aba2f38b Add headless guide (#3514) 
* Add custom frontend use case guide

Documents the @mintlify/astro integration for building custom
documentation frontends. Covers setup from the starter repo,
how the integration works, and connecting search/assistant.

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

* Fix Vale errors and broken link in custom frontend guide

Add Astro to Vale vocabulary, fix em dash spacing, and remove
broken /ai/search link.

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

* Add custom frontend link to guides index

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

* Fix Node.js version requirement to v20.17.0+

Matches the Mintlify CLI minimum requirement.

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

* create custom frontend guide

* Rewrite setup steps to match actual onboarding flow

* copyedit

* reviewer feedback

* add image of repo settings

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
 2026-02-18 08:10:02 -08:00
Ethan Palm ab04a0c437 fix anchor links (#3516) 2026-02-17 16:06:55 -08:00
mintlify-development[bot] 2518f5a8a5 Fix duplicate list numbering in linking guide (#3259) 
Co-authored-by: Mintlify Agent <agent@mintlify.com>
 2026-02-09 09:34:07 -08:00
mintlify[bot] 624c8ff594 Document default language configuration (#3118) 
* Document default language configuration

* Add single language documentation section

* Clarify that first language in array is default

---------

Co-authored-by: Mintlify Agent <agent@mintlify.com>
 2026-02-04 12:10:49 -08:00
Ethan Palm e26f17e0e7 update pro plan availability (#3002) 2026-01-30 13:37:21 -08:00
Ethan Palm e819807cd8 rename "custom" to "enterprise" (#2997) 2026-01-30 10:34:54 -08:00
Ethan Palm 8e7824a61e Update assistant embed guide for Next.js example (#2982) 
* include Next.js example

* vale
 2026-01-30 10:14:51 -08:00
Ethan Palm 596bd56fc2 use direct links instead of redirects (#2901) 2026-01-27 11:59:01 -08:00
Ethan Palm aeb0f7ea5e rem hreflang tag section (#2896) 2026-01-27 11:07:35 -08:00
Ethan Palm 99550b688b Add linking and references guide (#2836) 
* Update guides/linking-and-references.mdx

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

* Update docs.json

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

* copy edit

* add to guides index

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-01-23 16:59:45 -08:00
mintlify[bot] e034135302 Update guides/accessibility.mdx (#2830) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-01-23 11:26:55 -08:00
mintlify[bot] 76228fcf88 Update authentication docs for public pages (#2802) 
* Update deploy/authentication-setup.mdx

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

* Update deploy/authentication-setup.mdx

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

* Update deploy/authentication-setup.mdx

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

* remove personalization pages

* update links to personalization

* fix TODO:s

* use wildcard redirects

* vale

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
 2026-01-22 15:14:12 -08:00
Ethan Palm 872b9f923d Use case guides: support center and developer docs (#2727) 
* update vale vocab

* add new guides to docs.json

* update guides overview

* create support center guide

* add dev docs guide

* vale
 2026-01-16 09:48:06 -08:00
mintlify[bot] 6f7210b0a9 Documentation edits made through Mintlify web editor (#2730) 
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
 2026-01-16 07:58:58 -07:00
Ethan Palm e2f711248c Document knowledge capture using the agent (#2722) 
* document knowledge capture using the agent

* Apply suggestions from code review

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

---------

Co-authored-by: tembo[bot] <208362400+tembo[bot]@users.noreply.github.com>
 2026-01-15 13:54:49 -08:00
Ethan Palm 131544a81e Update knowledge base guide (#2707) 
* Update knowledge-base.mdx

* vale
 2026-01-15 09:33:45 -08:00
Ethan Palm 55de88ff3f fix indentation (#2615) 2026-01-08 16:22:20 -08:00
Ethan Palm 9d22f79a44 Cursor rule update (#2612) 
* split cursor rules into writing standards and component use

* remove duplicate content

* update cursor and windsurf guides
 2026-01-08 14:23:59 -08:00
Ethan Palm b3974550ae Add i18n guide (#2587) 
* add i18n guide

* combine with agent PR
 2026-01-08 12:02:09 -08:00
Ethan Palm 8bbf5083fb Add content templates (#2569) 
* add templates

* update supporting docs

* update reference template
 2026-01-07 10:12:26 -08:00
Han Wang ccc30217b5 undo relative pages for french relative page 2025-12-30 22:05:44 -06:00
Han Wang 9b16c1480f test relative page 2025-12-30 22:02:09 -06: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 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
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