@@ -4,17 +4,15 @@ description: "Deploy your documentation site and make your first changes."
44keywords : ["quickstart", "deploy", "get started", "first steps"]
55---
66
7- After completing this guide, you will have a live documentation site ready to customize and expand.
8-
97<Info >
108
11- ** Prerequisites** : Before you begin, [ create an account] ( https://mintlify.com/start ) and complete onboarding.
9+ ** Prerequisites** : [ Create an account] ( https://mintlify.com/start ) and complete onboarding.
1210
1311</Info >
1412
15- ## Getting started
13+ ## Your documentation site
1614
17- After you complete the onboarding process , your documentation site automatically deploys to a unique URL with this format :
15+ After onboarding, your site is live at :
1816
1917```
2018https://<your-project-name>.mintlify.app
@@ -27,50 +25,27 @@ Find your URL on the Overview page of your [dashboard](https://dashboard.mintlif
2725 <img src = " /images/quickstart/mintlify-domain-dark.png" alt = " Mintlify Domain" className = " hidden dark:block" />
2826</Frame >
2927
30- Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site.
31-
32- ### Install the GitHub App
28+ ## Connect GitHub
3329
34- Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
30+ Install the GitHub App to automate deployments:
3531
36- Install the GitHub App by following the instructions from the onboarding checklist or your dashboard.
37-
38- 1 . Navigate to ** Settings** in your Mintlify dashboard.
39- 2 . Select ** GitHub App** from the sidebar.
40- 3 . Select ** Install GitHub App** . This opens a new tab to the GitHub App installation page.
41- 4 . Select the organization or user account where you want to install the app.
42- 5 . Select the repositories that you want to connect.
32+ 1 . Go to ** Settings** → ** GitHub App** in your dashboard.
33+ 2 . Select ** Install GitHub App** and choose your organization.
34+ 3 . Select the repositories to connect.
4335
4436<Frame >
4537 <img src = " /images/quickstart/github-app-installation-light.png" alt = " GitHub App Installation" className = " block dark:hidden" />
4638 <img src = " /images/quickstart/github-app-installation-dark.png" alt = " GitHub App Installation" className = " hidden dark:block" />
4739</Frame >
4840
49- <Info >
50- Update the GitHub App permissions if you move your documentation to a different repository.
51- </Info >
41+ Then authorize your account:
5242
53- ### Authorize your GitHub account
43+ 1 . Go to ** Settings** → ** My Profile** .
44+ 2 . Select ** Authorize GitHub account** .
5445
55- 1 . Navigate to ** Settings** in your Mintlify dashboard.
56- 2 . Select ** My Profile** from the sidebar.
57- 3 . Select ** Authorize GitHub account** . This opens a new tab to the GitHub authorization page.
46+ ## Choose your workflow
5847
59- <Info >
60- An admin for your GitHub organization may need to authorize your account depending on your organization settings.
61- </Info >
62-
63- ## Editing workflows
64-
65- Mintlify offers two workflows for creating and maintaining your documentation:
66-
67- <Card title = " Code-based workflow" icon = " terminal" horizontal href = " #code-based-workflow" >
68- For users who prefer working with existing tools in their local environment. Click to jump to this section.
69- </Card >
70-
71- <Card title = " Web editor workflow" icon = " mouse-pointer-2" horizontal href = " #web-editor-workflow" >
72- For users who prefer a visual interface in their web browser. Click to jump to this section.
73- </Card >
48+ Pick the workflow that fits your team:
7449
7550## Code-based workflow
7651
0 commit comments