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
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.
32
+
This URL becomes available immediately and updates when you make changes to your documentation. Use this URL for testing and sharing with your team during development.
33
33
34
34
### Install the GitHub App
35
35
36
-
Mintlify provides a GitHub App that automates the deployment process when you push changes to your repository.
36
+
Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
37
37
38
-
You can install the GitHub App by following the instructions from the onboarding checklist or from your dashboard.
38
+
Install the GitHub App by following the instructions from the onboarding checklist or from your dashboard.
39
39
40
40
1. Navigate to **Settings** in your Mintlify dashboard.
41
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.
42
+
3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page.
43
43
4. Select the organization or user account where you want to install the app. Then select the repositories that you want to connect.
44
44
45
45
<Frame>
@@ -48,38 +48,38 @@ You can install the GitHub App by following the instructions from the onboarding
48
48
</Frame>
49
49
50
50
<Info>
51
-
Remember to update the GitHub App permissions if you move the documentation to a different repository.
51
+
Update the GitHub App permissions if you move your documentation to a different repository.
52
52
</Info>
53
53
54
54
### Authorize your GitHub Account
55
55
56
56
1. Navigate to **Settings** in your Mintlify dashboard.
57
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.
58
+
3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page.
59
59
60
60
<Info>
61
-
You may need an admin for your GitHub organization to authorize your account depending on your organization's settings.
61
+
An admin for your GitHub organization may need to authorize your account depending on your organization settings.
62
62
</Info>
63
63
64
64
## Editing Workflows
65
65
66
-
Mintlify offers two different workflows for creating and maintaining your documentation.
66
+
Mintlify offers two workflows for creating and maintaining your documentation.
For those who prefer a visual interface. Click to jump to section.
73
+
For users who prefer a visual interface in their web browser. Click to jump to this section.
74
74
</Card>
75
75
76
76
## Code-Based Workflow
77
77
78
-
The code-based workflow integrates with your existing development environment and Git repositories, making it ideal for technical teams who want to manage documentation alongside their code.
78
+
The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code.
79
79
80
80
### Install the CLI
81
81
82
-
To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running the following command in your terminal:
82
+
To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal:
83
83
84
84
<CodeGroup>
85
85
@@ -105,9 +105,9 @@ pnpm add -g mint
105
105
106
106
### Edit the Documentation
107
107
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:
108
+
After you set up your environment, you can start editing your documentation files. For example, update the title of the introduction page:
109
109
110
-
Open your repository created during onboarding, find the `introduction.mdx` file, and find the top of the file, that should look like this:
110
+
Open your repository created during onboarding, find the `introduction.mdx` file, and find the top of the file:
111
111
112
112
```jsx introduction.mdx
113
113
---
@@ -127,7 +127,7 @@ description: "This is the introduction to the documentation"
127
127
128
128
### Preview the Changes
129
129
130
-
To preview the changes locally, run the following command.
130
+
To preview the changes locally, run this command:
131
131
132
132
```bash
133
133
mint dev
@@ -142,27 +142,27 @@ Your preview will be available at `localhost:3000`.
142
142
143
143
### Push the Changes
144
144
145
-
When you're ready to publish your changes, simply push the changes to your repository.
145
+
When you are ready to publish your changes, push the changes to your repository.
146
146
147
-
Mintlify will automatically detect the changes, build your documentation, and deploy the updates to your site. You can monitor the deployment status in your GitHub repository's commit history or the [dashboard](https://dashboard.mintlify.com).
147
+
Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).
148
148
149
-
Once the deployment is complete, your last update will be available at `<your-project-name>.mintlify.app`.
149
+
After the deployment is complete, your latest update will be available at `<your-project-name>.mintlify.app`.
150
150
151
151
<Cardtitle="Jump to adding a custom domain"icon="arrow-down"href="#adding-a-custom-domain"horizontal>
152
-
Optionally skip the web editor workflow and jump to adding a custom domain.
152
+
Optionally, skip the web editor workflow and jump to adding a custom domain.
153
153
</Card>
154
154
155
155
## Web Editor Workflow
156
156
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.
157
+
The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools.
158
158
159
159
### Access the Web Editor
160
160
161
161
1. Log in to your [Mintlify Dashboard](https://dashboard.mintlify.com).
162
162
2. Select **Editor** on the left sidebar.
163
163
164
164
<Info>
165
-
If you haven't installed the GitHub App, you will be prompted to do so upon opening the web editor.
165
+
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.
166
166
</Info>
167
167
168
168
<Frame>
@@ -172,7 +172,7 @@ The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interf
172
172
173
173
### Edit the Documentation
174
174
175
-
In the web editor, you can navigate your documentation files in the sidebar. Let's update the introduction page.
175
+
In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:
176
176
177
177
Find and click on `introduction.mdx` in the file explorer.
178
178
@@ -184,14 +184,14 @@ Then, in the visual editor, update the title field to "Hello World".
184
184
</Frame>
185
185
186
186
<Tip>
187
-
The editor provides a rich set of formatting tools and components. Access them by typing "/" in the editor to open the command menu.
187
+
The editor provides a rich set of formatting tools and components. Type <kbd>/</kbd> in the editor to open the command menu and access these tools.
188
188
</Tip>
189
189
190
190
### Publish Your Changes
191
191
192
-
When you're satisfied with your edits, click the `Publish` button in the top-right corner.
192
+
When you are satisfied with your edits, click the `Publish` button in the top-right corner.
193
193
194
-
Your changes will be deployed immediately to your documentation site.
194
+
Your changes are immediately deployed to your documentation site.
195
195
196
196
For more details about using the web editor, including advanced features like slash commands and image uploads, see our [Web Editor documentation](/editor).
197
197
@@ -206,7 +206,7 @@ To add a custom domain, go to `Settings` > `Custom Domain` from the dashboard.
Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructions to configure DNS settings with your domain provider.
209
+
Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS (Domain Name System) settings with your domain provider.
210
210
211
211
<Table>
212
212
| Record Type | Name | Value | TTL |
@@ -215,12 +215,12 @@ Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructi
215
215
</Table>
216
216
217
217
<Info>
218
-
DNS changes can take up to 48 hours to propagate, though they often complete much sooner.
218
+
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
219
219
</Info>
220
220
221
221
## Next Steps
222
222
223
-
Congratulations! You've successfully deployed your documentation site with Mintlify. Here are some suggested next steps to enhance your documentation:
223
+
Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:
224
224
225
225
<Cardtitle="Customize Your Theme"icon="paintbrush"href="themes"horizontal>
226
226
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
@@ -237,11 +237,11 @@ Congratulations! You've successfully deployed your documentation site with Mintl
237
237
238
238
## Troubleshooting
239
239
240
-
If you encounter any issues during the setup process, check our common troubleshooting solutions:
240
+
If you encounter issues during the setup process, check these common troubleshooting solutions:
241
241
242
242
<AccordionGroup>
243
243
<Accordiontitle="Local preview not working">
244
-
Make sure you have Node.js v19+ installed and that you're running the `mint dev` command from the directory containing your `docs.json` file.
244
+
Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file.
245
245
</Accordion>
246
246
<Accordiontitle="Changes not reflecting on live site">
247
247
Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.
0 commit comments