Skip to content

Streamline quickstart page #2560

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 wants to merge 1 commit into from
Closed

Streamline quickstart page #2560

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
44 changes: 4 additions & 40 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,48 +6,14 @@

After you complete this guide, you'll have a live documentation site ready to customize and update.

## 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 Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.

## 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.

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
If you want to get started quickly without connecting your own repository, you can skip the GitHub 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 and migrate to your own repository later.
</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
src="/images/quickstart/mintlify-domain-light.png"
alt="Overview page of the Mintlify dashboard."
className="block dark:hidden"
/>

<img
src="/images/quickstart/mintlify-domain-dark.png"
alt="Overview page of the Mintlify dashboard."
className="hidden dark:block"
/>
</Frame>
After onboarding, your documentation site is deployed and accessible at `https://<your-project-name>.mintlify.app`. Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

Check warning on line 13 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L13 

In general, use active voice instead of passive voice ('is deployed').

<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).
Your site is ready to view immediately. Before sharing with users, you may want to add a [custom domain](/customize/custom-domain).
</Tip>

## Make your first change
Expand All @@ -56,7 +22,7 @@
<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.
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.

Check warning on line 25 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L25 

Use 'command-line tool' instead of 'CLI'.

<CodeGroup>

Expand All @@ -70,8 +36,6 @@
```

</CodeGroup>

See [Install the CLI](/installation) for full details and troubleshooting.
</Step>
<Step title="Clone your repository">
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository).
Expand Down Expand Up @@ -133,11 +97,11 @@
</Tab>
</Tabs>

## Next steps

Check warning on line 100 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L100 

'Next steps' should use sentence-style capitalization.

<Columns cols={3}>
<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.

Check warning on line 104 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L104 

Avoid using 'will'.
</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
Expand All @@ -145,4 +109,4 @@
<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
</Columns>
</Columns>