Skip to content

docs: condense quickstart page #5774

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.

Sign up for GitHub

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

Closed
mintlify-development wants to merge 1 commit into from
Closed

docs: condense quickstart page #5774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
78 changes: 18 additions & 60 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,57 +7,32 @@ boost: 3

import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";

After you complete this guide, you'll have a live documentation site ready to customize and update.
Deploy a live documentation site and make your first change.

## Before you begin

Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.

When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
Mintlify uses a docs-as-code approach: every page on your site has a corresponding file in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored.">repository</Tooltip>. Edit files locally or in the web editor and sync changes to your remote repository.

<Tip>
Using an AI coding tool?

Copy the following prompt to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when updating your documentation.
Using an AI coding tool? Copy the prompt below to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol).
</Tip>

<SkillMcpPrompt />

## Deploy your documentation site

Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.
Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. You'll connect GitHub, select a repository, and install the GitHub App for automatic deployments.

After onboarding, your documentation site deploys and is accessible at your `.mintlify.app` URL.
Your site deploys to `https://<your-project-name>.mintlify.app`. Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

<AccordionGroup>
<Accordion title="Optional: Skip connecting a Git provider during onboarding">
If you want to get started quickly without connecting your own repository, you can skip the Git provider connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you.

This lets you use the web editor immediately. If you want to use your own repository later, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard to migrate your content using the Git setup wizard. See [Clone to your own repository](/deploy/github#clone-to-your-own-repository) for details.
<Accordion title="Skip connecting a Git provider">
To get started without your own repository, skip the Git provider connection during onboarding. Mintlify creates a private repository and configures the GitHub App for you. Migrate to your own repository later from [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings). See [Clone to your own repository](/deploy/github#clone-to-your-own-repository).
</Accordion>
</AccordionGroup>

## View your deployed site

Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.

Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

<Frame>
<img
alt="Overview page of the Mintlify dashboard."
className="block dark:hidden"
src="/images/quickstart/mintlify-domain-light.png"
/>
<img
alt="Overview page of the Mintlify dashboard."
className="hidden dark:block"
src="/images/quickstart/mintlify-domain-dark.png"
/>
</Frame>

<Tip>
Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain).
Before sharing with users, add a [custom domain](/customize/custom-domain).
</Tip>

## Make your first change
Expand All @@ -66,7 +41,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.
Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.

<CodeGroup>

Expand All @@ -80,40 +55,26 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa

</CodeGroup>

See [Install the CLI](/cli/install) for full details and troubleshooting.
See [Install the CLI](/cli/install) for details.
</Step>
<Step title="Clone your repository">
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/cli/install#clone-your-repository).
Follow [Clone your repository](/cli/install#clone-your-repository) if you haven't already.
</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:

```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
</Step>
<Step title="Preview locally">
Run the following command from your documentation directory:
<Step title="Edit and preview">
Update the `description` in `index.mdx`, then preview at `http://localhost:3000`:

```bash
mint dev
```

View your preview at `http://localhost:3000`.
</Step>
<Step title="Push your changes">
Commit and push your changes to trigger a deployment:
Commit and push to trigger a deployment:

```bash
git add .
git commit -m "Update description"
git push
```

Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
</Step>
</Steps>
</Tab>
Expand All @@ -122,8 +83,8 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
<Step title="Open the web editor">
Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
</Step>
<Step title="Edit a page">
Open the **Introduction** page and update the description.
<Step title="Edit the Introduction page">
Open **Introduction** and update the description.

<Frame>
<img
Expand All @@ -139,10 +100,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
</Frame>
</Step>
<Step title="Publish">
Click **Publish** in the top-right of the web editor toolbar.
</Step>
<Step title="View live">
On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live.
Click **Publish** in the toolbar. Track deployment on the [Overview](https://dashboard.mintlify.com/) page.
</Step>
</Steps>
</Tab>
Expand All @@ -160,4 +118,4 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa

<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
</Card>
Loading