You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: quickstart.mdx
+36-22Lines changed: 36 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,37 @@ You can find your URL from the Overview page of the dashboard.
31
31
32
32
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.
33
33
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.
Remember to update the GitHub App permissions if you move the documentation to a different repository.
91
-
</Info>
92
-
93
106
### Edit the Documentation
94
107
95
108
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
141
154
142
155
## Web Editor Workflow
143
156
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.
145
158
146
159
### Access the Web Editor
147
160
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.
149
163
150
164
<Info>
151
165
If you haven't installed the GitHub App, you will be prompted to do so upon opening the web editor.
0 commit comments