Skip to content

Golden river #7042

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

Golden river #7042

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
6 changes: 2 additions & 4 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Quickstart"
description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git."
description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git. "
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
boost: 3
---
Expand Down Expand Up @@ -30,15 +30,13 @@
2. Run `mint --version`. If the command is unavailable, install the CLI with `npm i -g mint` or `pnpm add -g mint`. If the command succeeds, run `mint update`.
3. Run `mint status` before starting authentication. If it already shows an organization, keep the existing session and do not create another account.
4. Run `mint login` if the user has an account. Otherwise, ask for their first name, last name, company, and email, then run:

```bash
mint signup \
--firstName <first-name> \
--lastName <last-name> \
--company <company> \
--email <email>
```

`mint signup` waits for email verification, so keep it running as a background process when your environment supports background commands. Tell the user to click the verification link and approve the CLI in the browser. Never invent signup details.
5. After the user finishes verification and onboarding, run `mint status` again. Confirm that it reports their email, organization, and subdomain. If the organization exists but no subdomain appears, ask the user to finish selecting or connecting a GitHub repository in the onboarding browser tab, then retry.
6. If the user has an existing documentation repository, clone or open it. Preserve its content. For a new local project, scaffold into a new, empty directory with either `mint new <directory> --name <name> --theme <theme>` or `mint new <directory> --template <template-name>`. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files.
Expand Down Expand Up @@ -71,7 +69,7 @@
</Visibility>

<Visibility for="agents">
Use the preceding CLI setup workflow. Initiate the corresponding `mint signup` or `mint login` command. Account verification and GitHub authorization open browser pages; have the user approve them. Continue the setup when they finish. Do not consider setup complete until `mint status` reports a subdomain and the deployed `.mintlify.site` URL loads.

Check warning on line 72 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L72 

Use semicolons judiciously.
</Visibility>

## View your deployed site
Expand Down Expand Up @@ -203,4 +201,4 @@

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