Commit Graph

80 Commits

Author SHA1 Message Date
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
Ethan Palm 11d10197bd update support links (#835) 2025-06-20 12:50:12 -07:00
Ethan Palm f0ad93ac1f Web editor guide (#830)
* update quickstart web editor content

* update introduction

* update Editor modes section

* move component menu to Making changes section

* update page structure

* remove info about CLI

* update introduction

* update editor modes

* update git fundamentals

* add info on deployment branches

* update branch procedures

* update making changes section

* add file menu images

* update PR section

* update troubleshooting

* add PR tip

* add reviewer feedback
2025-06-18 17:31:10 -07:00
Ethan Palm c02273c08f Update conceptual info about docs.json (#822)
* update intro

* add conceptual content

* fill empty ResponseFields

* remove redundant section

* update title, description, intro

* update setting up your `docs.json`

* update customization reference

* navbar & navigation reference

* footer & banner

* redirects & contextual menu

* api ref

* SEO and search ref

* integrations & errors

* add example configs

* include `docs.json` as next step in quickstart

* remove space

* add reviewer feedback
2025-06-17 16:18:37 -07:00
mintlify[bot] f4fa98a9cb Remove Node.js v19 specific requirement from quickstart page (#820)
* Remove Node.js v19 specific requirement from quickstart page

* Remove Node.js v19 version requirement from installation page

* Revert change in "Local preview not working" accordion to specify Node.js v19+ requirement

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2025-06-13 18:29:02 -07:00
Ethan Palm c89323a3ef Editor updates (#797)
* explain when publish pushes changes live

* clarify what an editor is

* explain publish button behavior

* clarify deployment vs main

* copyediting
2025-06-13 15:38:21 -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
mintlify[bot] ca919104a9 Improve quickstart documentation for better translatability (#750)
* Documentation edits made through Mintlify web editor

* 💅

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2025-05-30 15:26:52 -07:00
mintlify[bot] ce8492303a Update support email links to documentation support page (#745)
* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* Update cloudflare.mdx

* Documentation edits made through Mintlify web editor

* Documentation edits made through Mintlify web editor

* fixed additional links

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: Dean from Mintlify <dean@mintlify.com>
2025-05-27 17:30:29 -07:00
Ethan Palm a50faee852 typo fix (#710)
* Guide through the GItHub auth flow

* change `Development` to `Mintlify`

* reviewer feedback

* typo
2025-05-15 12:37:00 -07:00
Ethan Palm d692223a82 Quickstart: guide through the GitHub setup (#709)
* Guide through the GItHub auth flow

* change `Development` to `Mintlify`

* reviewer feedback
2025-05-15 11:22:32 -07:00
Han Wang 6cef8d300a Add references to CLI 2025-05-05 16:23:45 -07:00
Han Wang 55a038437f Use mint CLI 2025-05-05 16:14:38 -07:00
Han Wang e83f797443 Root level core concepts (#687) 2025-05-05 14:56:44 -07:00
Brandon Waselnuk 883d97d009 quickstart link to signup (#673)
* quickstart link to signup
2025-04-28 14:35:34 -07:00
Han Wang b70441a6e3 Update quickstart 2025-04-28 13:37:01 -07:00
Han Wang b2374cc9f3 Update pages 2025-04-28 01:14:19 -07:00
Han Wang d662a2a290 Remove files 2025-04-27 22:52:53 -07:00
Han Wang b96ffbb652 Fix a lot of broken links 2025-04-27 13:33:09 -07:00
Han Wang 5fa58bd258 Update quickstart website 2025-04-27 02:20:30 -07:00
Han Wang b4d37f6099 Update quickstart section 2025-04-27 01:54:51 -07:00
Han Wang 3384ea43f1 Use core-concepts 2025-04-24 11:43:25 -07:00
Han Wang 414b797ce2 Update pages 2025-04-24 11:28:25 -07:00
Han Wang 4d80b1f578 Update pages 2025-04-23 19:16:35 -07:00
Han Wang 3f0fc9747c Han/custom homepage (#667)
* Add initial setup for custom intro page

* Add initial cards

* Add dynamic pages

* Add hrefs
2025-04-23 19:08:53 -07:00
Dean from Mintlify b4ff175f93 Clarrify community != support (#621)
* Documentation edits made through Mintlify web editor

* Update quickstart.mdx

* Update quickstart.mdx

* Update quickstart.mdx

never liked this final line lmao

---------

Co-authored-by: tiffany-mintlify <tiffany@mintlify.com>
2025-04-09 14:35:13 -07:00
Prithvi Ramakrishnan db23dcffbf Fix broken link to mintlify dashboard settings in quickstart.mdx (#543)
www.dashboard.mintlify.com -> dashboard.mintlify.com
2025-02-21 22:02:55 -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
Sahu97494 f890babb4b Quickstart edits (#401)
* monorepo update

* monorepo_anahita

* Update quickstart.mdx

Removed weird spacing and removed the contact us in the first accordion

* Cleanup

* Fix gitignore

* Revert gitignore

* Remove weird files

* ^

* remove reach out to us callout

---------

Co-authored-by: Ricardo Nunez <113212961+ricardonunez-io@users.noreply.github.com>
Co-authored-by: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com>
2025-01-02 15:05:58 -08:00
Han Wang bafc498391 Han's docs n donuts (#438)
* Fix broken link

* Han's changes
2025-01-02 16:49:32 -05: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
Ricardo Nunez 4f5a900d5e Add web editor documentation (#357)
* Add web editor documentation

* Fix broken links

* Easier readability

* Undo

* Update current web editor docs

* UX improvements

* Minor changes

* Fix typos and add OpenAPI limitation
2024-11-14 14:33:28 -08:00
Hahnbee Lee 5a9a24c563 Revert "Halloween (#321)" (#323)
This reverts commit 2fb736da37.
2024-11-01 10:05:53 -07:00
Ricardo Nunez 2fb736da37 Halloween (#321)
* Halloween

* Update quickstart.mdx
2024-10-31 14:05:15 -07:00
mintlifydavid 9d77c435b2 hello world to getting started 2024-10-23 08:01:34 -07:00
mintlifydavid 0d8500eb81 getting started to hello world 2024-10-23 07:41:25 -07:00
Hahnbee Lee a916ab00ca Remove test on quickstart 2024-10-23 00:14:21 -07:00
Hahnbee Lee f646c952a0 Add changelog (#311)
* add changelog

* add more fixes
2024-10-23 00:10:32 -07:00
mintlifydavid 7fe47e9b27 hello back to welcome 2024-10-22 13:55:55 -07:00
mintlifydavid ed91075bda welcome to hello 2024-10-22 13:54:40 -07:00
mintlifydavid cc9be4e97d 5 to five 2024-10-22 09:29:41 -07:00
mintlifydavid c07f7a235d five to 5 2024-10-22 09:18:44 -07:00
Han Wang 120e2e8011 Update starter template to starter kit 2024-10-07 14:15:22 -07:00
Han Wang c2aa3862ef Remove period 2024-09-13 11:15:43 -07:00
Han Wang f411b241e0 Update the docs 2024-09-13 11:15:04 -07:00
Hahnbee Lee 9bc55e7a12 shorten greeting (#263) 2024-08-30 10:55:09 -07:00
Sahu97494 2bfb69c87a monorepo update (#248)
* monorepo update

* monorepo_anahita
2024-08-22 11:28:02 -07:00
Hahnbee Lee 30e0e9a12c Add broken links CI (#238)
* Add broken links CI

* fix all broken links
2024-08-22 13:37:23 -04:00
mintlifydavid 168a021cae Updating contacts and play type for migration (#245)
* Updated the description

* updated contact email and startup to enterprise for migrations

* five to 5
2024-08-12 19:14:58 -04:00