Skip to content

Commit d692223

Browse files
authored
Quickstart: guide through the GitHub setup (#709)
* Guide through the GItHub auth flow * change `Development` to `Mintlify` * reviewer feedback
1 parent 48482fb commit d692223

File tree

1 file changed

+36
-22
lines changed

1 file changed

+36
-22
lines changed

quickstart.mdx

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,37 @@ You can find your URL from the Overview page of the dashboard.
3131

3232
This URL is instantly available and will update whenever you make changes to your documentation. It's perfect for testing and sharing with your team during development.
3333

34-
## Development Workflows
34+
### Install the GitHub App
35+
36+
Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository.
37+
38+
You can install the GitHub App by following the instructions from the onboarding checklist or from your dashboard.
39+
40+
1. Navigate to **Settings** in your Mintlify dashboard.
41+
2. Select **GitHub App** from the sidebar.
42+
3. Select **Install GitHub App**. This will open a new tab to the GitHub App installation page.
43+
4. Select the organization or user account where you want to install the app. Then select the repositories that you want t oconnect.
44+
45+
<Frame>
46+
<img src="/images/quickstart/github-app-installation-light.png" alt="GitHub App Installation" className="block dark:hidden" />
47+
<img src="/images/quickstart/github-app-installation-dark.png" alt="GitHub App Installation" className="hidden dark:block" />
48+
</Frame>
49+
50+
<Info>
51+
Remember to update the GitHub App permissions if you move the documentation to a different repository.
52+
</Info>
53+
54+
### Authorize your GitHub Account
55+
56+
1. Navigate to **Settings** in your Mintlify dashboard.
57+
2. Select **My Profile** from the sidebar.
58+
3. Select **Authorize GitHub account**. This will open a new tab to the GitHub authorization page.
59+
60+
<Info>
61+
You may need an admin for your GitHub organization to authorize your account depending on your organization's settings.
62+
</Info>
63+
64+
## Editing Workflows
3565

3666
Mintlify offers two different workflows for creating and maintaining your documentation.
3767

@@ -73,23 +103,6 @@ pnpm add -g mint
73103
You need Node.js version 19 or higher installed on your machine. If you encounter installation issues, check the troubleshooting guide.
74104
</Info>
75105

76-
### Install the GitHub App
77-
78-
Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository.
79-
80-
You can install the GitHub App by following the instructions from the onboarding checklist or by navigating to `Settings` > `Organization` > `GitHub`.
81-
82-
Click `Install GitHub App`. Select the repositories you want to connect.
83-
84-
<Frame>
85-
<img src="/images/quickstart/github-app-installation-light.png" alt="GitHub App Installation" className="block dark:hidden" />
86-
<img src="/images/quickstart/github-app-installation-dark.png" alt="GitHub App Installation" className="hidden dark:block" />
87-
</Frame>
88-
89-
<Info>
90-
Remember to update the GitHub App permissions if you move the documentation to a different repository.
91-
</Info>
92-
93106
### Edit the Documentation
94107

95108
Now that your environment is set up, you can start editing your documentation files. As an example, let's update the title of the introduction page:
@@ -141,19 +154,20 @@ Once the deployment is complete, your last update will be available at `<your-pr
141154

142155
## Web Editor Workflow
143156

144-
The web editor workflow provides a WYSIWYG interface for creating and editing documentation without requiring local development tools. It's ideal for non-technical team members or for making quick updates.
157+
The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. It's ideal for people who want to work in their web browser without additional local development tools.
145158

146159
### Access the Web Editor
147160

148-
Log in to your Mintlify Dashboard and select your project. Navigate to `Editor` on the left sidebar to open the web editor.
161+
1. Log in to your [Mintlify Dashboard](https://dashboard.mintlify.com).
162+
2. Select **Editor** on the left sidebar.
149163

150164
<Info>
151165
If you haven't installed the GitHub App, you will be prompted to do so upon opening the web editor.
152166
</Info>
153167

154168
<Frame>
155-
<img alt="Web Editor" src="/images/quickstart/web-editor-light.png" className="block dark:hidden" />
156-
<img alt="Web Editor" src="/images/quickstart/web-editor-dark.png" className="hidden dark:block" />
169+
<img alt="The Mintlify web editor in the visual editor mode" src="/images/quickstart/web-editor-light.png" className="block dark:hidden" />
170+
<img alt="The Mintlify web editor in the visual editor mode" src="/images/quickstart/web-editor-dark.png" className="hidden dark:block" />
157171
</Frame>
158172

159173
### Edit the Documentation

0 commit comments

Comments
 (0)