Skip to content

docs retreat overhaul #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
how mintlify works
  • Loading branch information
hahnbeelee committed Apr 11, 2025
commit c4077e872e7d1527f9b3093cf5450c91db66eb61
18 changes: 18 additions & 0 deletions how-mintlify-works.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: How Mintlify Works
description: Mintlify is a platform that helps you build and deploy beautiful, LLM and SEO-friendly documentation.
---

Mintlify is a framework that helps you build and deploy documentation. You create MDX files with our custom components to build your docs.

Under the hood, Mintlify powers your search, analytics, and more. This allows you to focus on building your product and leave the documentation to us.

Whether you're an individual developer or part of a larger team, Mintlify can help you build interactive, dynamic, and fast documentation.

## Editing experience

Mintlify uses a git-based workflow to track changes and deploy your docs. This is a convenient workflow for most developers because they can use their existing tools to edit their docs. However, if you're not familiar with git, we also have a web-based editor that you can use to edit your docs.

### Local CLI

### Web Editor
56 changes: 0 additions & 56 deletions introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,59 +14,3 @@ description: "Welcome to the home of your new documentation"
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
/>
</Frame>

## Setting up

The first step to world-class documentation is setting up your editing environments.

<CardGroup cols={2}>
<Card
title="Edit Your Docs"
icon="pen-to-square"
href="https://mintlify.com/docs/quickstart"
>
Get your docs set up locally for easy development
</Card>
<Card
title="Preview Changes"
icon="image"
href="https://mintlify.com/docs/development"
>
Preview your changes before you push to make sure they're perfect
</Card>
</CardGroup>

## Make it yours

Update your docs to your brand and add valuable content for the best user conversion.

<CardGroup cols={2}>
<Card
title="Customize Style"
icon="palette"
href="https://mintlify.com/docs/settings/global"
>
Customize your docs to your company's colors and brands
</Card>
<Card
title="Reference APIs"
icon="code"
href="https://mintlify.com/docs/api-playground/openapi"
>
Automatically generate endpoints from an OpenAPI spec
</Card>
<Card
title="Add Components"
icon="screwdriver-wrench"
href="https://mintlify.com/docs/content/components/accordions"
>
Build interactive features and designs to guide your users
</Card>
<Card
title="Get Inspiration"
icon="stars"
href="https://mintlify.com/customers"
>
Check out our showcase of our favorite documentation
</Card>
</CardGroup>