Commit Graph

78 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 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 9e33c21779 Update speakeasy integration guide (#913)
* update content

* add image files

* add frames
2025-07-15 09:38:19 -07:00
Ethan Palm cb7180b5a0 add undocumented events (#856) 2025-06-25 14:36:35 -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 3a50c90582 update event names (#825) 2025-06-17 17:01:09 -07:00
Ethan Palm bc300dd9e7 Make analytics events more discoverable (#811)
* bring events out of accordion

* change list to table
2025-06-12 17:17:20 -07:00
Ethan Palm 800f6dceff fix styling of code in step (#755) 2025-05-28 16:54:44 -07:00
Ethan Palm 6f00cd27e5 API playground docs refresh (#723)
* add outline

* update overview

* add a quickstart

* update grouping and titles

* Add getting started info to overview

* update info on adding openAPI doc

* remove repeated link

* update info on auto-generating pages

* remove mindsdb image

* update MDX info

* remove files combined into OpenAPI setup

* add redirects

* rewrite MDX intro

* upate steps

* undo reorging MDX content

* create files for customization group

* update `docs.json`

* add content for complex data types

* add content for managing page visibility

* Add SDK examples content

* delete advanced features page

* add description for SDK page

* add info on multiple responses

* fix broken links

* Copilot edits

* Copy edit overview

* Copy edit of OpenAPI setup

* Copyedit customization pages

* consistent heading capitalization

* add reviewer feedback
2025-05-28 11:53:38 -07:00
Ethan Palm 3bf75fc9a6 Update the Stainless integration process (#706)
* Update the stainless integration process

* Polish

* Add reviewer feedback
2025-05-14 16:58:08 -07:00
Hahnbee Lee ffd2d62fd2 fix: analytics overview (#650) 2025-04-11 17:19:44 -07:00
Dean from Mintlify 44801fd002 Removed: GA4 example from integrations (#615)
* Documentation edits made through Mintlify web editor

* add missing integrations

* fix icons

* remove spaces

---------

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
2025-04-11 17:15:45 -07:00
Ruhan Ponnada 3ccba78d8d Updated PostHog API Key Description (#600)
* updated api key usage

* fixed comma
2025-03-31 23:44:17 -07:00
Han Wang 0a17bd8ba4 Update brackets to integrations 2025-03-27 10:27:56 -07:00
Brandon Waselnuk 5e861eea94 all integrations have quotes now (#568)
* all integrations have quotes now

* fixed 2 broken links

* vale found the the
2025-03-12 15:42:33 -07:00
dino475 da1629d1a4 Hotfix: Changing intercom to appId (to reflect docs.json spec) (#567)
* Changing intercom to appId to reflect docs.json

* quick edit to add back intercom
2025-03-12 14:39:16 -07:00
Kathryn Isabelle Lawrence 24a42de503 Update docs for GDPR/Cookies Consent integrations (#540)
* add snippet for disabling telemetry

* reword and mention cookies explicitly

* explicitly mention Posthog

* remove first line

* Update integrations/privacy/overview.mdx

Co-authored-by: Ricardo Nunez <113212961+ricardonunez-io@users.noreply.github.com>

* add other cookie consent thing

* update cookies keys

---------

Co-authored-by: Ricardo Nunez <113212961+ricardonunez-io@users.noreply.github.com>
2025-03-03 11:38:56 -08:00
dino475 28cdbad61b added segment to the code block (#539)
LFG
2025-02-20 13:30:47 -08:00
Han Wang e1210834db Update docs for GA 2025-02-10 22:38:00 -08:00
mintlify[bot] 38d1f02f95 Documentation edits made through Mintlify web editor (#522)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-02-10 11:29:38 -08:00
Ruhan Ponnada da0b605d83 Replacing mint.json to docs.json (#506)
* Replacing mint.json to docs.json for everythin except versioning and navigation

* Reflected docs.json for navigation and versioning
2025-02-04 20:24:52 -08:00
tiffany-mintlify 09f7992a90 added analytics events to analytics page (#439)
* added analytics events to analytics page

* make it an FAQ section

---------

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
2025-01-02 16:49:17 -05:00
Hahnbee Lee 7d79d6d3a1 add Plausible server config (#422) 2024-12-12 19:07:46 -08:00
Han Wang 7fab200203 Styling improvements and updates to quickstart and group editing (#359)
* Use inter variable for font on headers

* Edit content and formatting

* Edit quickstart

* Move SSO
2024-11-14 16:55:09 -08:00
flo merian 7671705d01 Fix typos in Integrations (#307) 2024-10-23 01:01:51 +02:00
Shubh Porwal 6589e0e6c6 Fix spellings (#197)
* fix: spellings

* fix: copy icon overlapping content

---------

Co-authored-by: Shubh Porwal <shubhporwal73@gmail.com>
2024-08-24 14:33:54 -07:00
Han Wang 6931b85680 Udate privacy integrations 2024-08-03 12:05:40 -07:00
Ronan McCarter 61727bf02b chore: separate integrations tab (#228)
* separate integrations into integrations/mintlify api/advanced

* move widget and rest api to advanced
2024-07-30 16:54:46 -07:00
Ricky Zhang be8d6c9d45 Add segment page (#229)
* add segment page

* fix logo size

* improve wording

Co-authored-by: Ronan McCarter <63772591+rpmccarter@users.noreply.github.com>

---------

Co-authored-by: Ronan McCarter <63772591+rpmccarter@users.noreply.github.com>
2024-07-25 22:06:15 -04:00
Abhinav kumar aa37f31aba docs: fix minor typos (#226) 2024-07-25 10:42:10 -07:00
Ricky Zhang 1ec1e366e1 Explain logo settings and mention custom scripts (#217)
* fixes

* Update global.mdx
2024-07-25 10:34:48 -07:00
James P 9f88a82ee2 Update chat.mdx (#220) 2024-07-25 10:19:42 -07:00
Abhinav kumar 5002912083 fix: adjust rendering for mdx files (#225)
* fix: adjust spacing for mdx files

* chores: fix auth

* chores: minor fix

* chores: fix spaces

* chores: add ons
2024-07-25 10:18:49 -07:00
Jacob Bijani 7e1ced3699 correct frontchat integration key (#221) 2024-07-25 10:12:22 -07:00
Ricky Zhang 4dcc1c0c88 Add widget page (#218)
* add widget page

* address comments

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>

* address comments

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>

* address comments

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>

* address comments

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>

* move widgets

* remove mintlify

---------

Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
2024-07-16 08:50:22 -07:00
Han Wang c370823c2c Edit horizontal cards and use an example (#213)
* Edit horizontal cards and use an example

* Add horizontal cards
2024-07-15 17:45:34 -07:00
Mayank Shouche 42f980e658 share subpath gating component (#210) 2024-07-11 10:44:50 -07:00
Ronan McCarter 8e518d1176 move jwt from query to hash (#208) 2024-07-10 12:17:11 -07:00
Ronan McCarter da133aef8e change markdown links to jsx links (#206) 2024-06-26 18:18:57 -07:00
Ronan McCarter 4e1ed75369 fix: update user auth copy (#204)
* Documentation edits made through Mintlify web editor

* add simple example

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
2024-06-26 17:16:55 -07:00
joshcolts18 216af36161 Fix broken link for sales email (#202) 2024-06-25 19:17:09 -07:00
mintlify-development[bot] 93a3572cab docs for User Auth (#194)
* 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

* improve overview info

* add docs for shared session

* add jwt docs

* add docs on shape of data

* add usage docs

* remove unnecessary optionals

* hide hidden pages docs since it's not out yet

* address comments

* add a better intro on the auth method page

* add sales callout

* remove "support" lol

---------

Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com>
Co-authored-by: Ronan McCarter <63772591+rpmccarter@users.noreply.github.com>
2024-06-24 21:44:39 -07:00
worktheclock 2c186d0456 Speakeasy proofread 2024-06-13 17:03:03 +02:00
Niel Thiart dcb65afc95 Trim inline code 2024-06-13 13:00:31 +02:00
Niel Thiart 5ca7d33cde Fix yaml indentation on Speakeasy integration page 2024-06-13 12:59:24 +02:00
Hahnbee Lee 852b2f6e7c add pricing gate 2024-05-29 15:14:40 -07:00
Hahnbee Lee 45bab0275c Update cloudflare screenshots 2024-05-28 22:45:41 -07:00
joshcolts18 26e5a65fe4 change to sales 2024-05-24 16:15:32 -07:00
Hahnbee Lee 06569bb9d3 move to integrations 2024-05-23 17:33:29 -04:00
joshcolts18 a9c86e22e3 Update stainless.mdx 2024-05-14 14:25:00 -07:00