Skip to content

Commit d52c53a

Browse files
shawniscanadianshawniscanadian
authored
Documentation edits made through Mintlify web editor
1 parent c3be25c commit d52c53a

File tree

1 file changed

+103
-118
lines changed

1 file changed

+103
-118
lines changed

‎editor.mdx‎

Lines changed: 103 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
2-
title: 'Web Editor'
3-
description: 'Build your documentation using the Mintlify Web Editor'
4-
icon: 'mouse-pointer-2'
2+
title: "Web Editor"
3+
description: "Build your documentation using the Mintlify Web Editor"
4+
icon: "mouse-pointer-2"
55
---
66

77
<img
88
className="block dark:hidden my-0 pointer-events-none"
99
src="/images/editor/editor-light.png"
1010
alt="Mintlify Web Editor interface in light mode"
1111
/>
12+
1213
<img
1314
className="hidden dark:block my-0 pointer-events-none"
1415
src="/images/editor/editor-dark.png"
@@ -37,17 +38,18 @@ Both workflows are fully integrated with your Git repository, so you can use the
3738

3839
The Web Editor offers two distinct modes to accommodate different editing preferences and needs.
3940

40-
You can switch between modes at any time using the toggle in the top right corner of the editor toolbar.
41+
You can switch between natural modes at any time using the toggle in the top right corner of the editor toolbar.
4142

4243
<Frame>
43-
<img
44-
src="/images/editor/mode-toggle-light.png"
45-
alt="Mode toggle in the Mintlify Web Editor"
44+
<img
45+
src="/images/editor/mode-toggle-light.png"
46+
alt="Mode toggle in the Mintlify Web Editor"
4647
className="block dark:hidden"
4748
/>
48-
<img
49-
src="/images/editor/mode-toggle-dark.png"
50-
alt="Mode toggle in the Mintlify Web Editor"
49+
50+
<img
51+
src="/images/editor/mode-toggle-dark.png"
52+
alt="Mode toggle in the Mintlify Web Editor"
5153
className="hidden dark:block"
5254
/>
5355
</Frame>
@@ -57,14 +59,15 @@ You can switch between modes at any time using the toggle in the top right corne
5759
Visual Mode provides a rich WYSIWYG experience where you can see exactly how your documentation will appear as you create it.
5860

5961
<Frame>
60-
<img
61-
src="/images/editor/visual-mode-light.png"
62-
alt="Visual editing mode in the Mintlify Web Editor"
62+
<img
63+
src="/images/editor/visual-mode-light.png"
64+
alt="Visual editing mode in the Mintlify Web Editor"
6365
className="block dark:hidden"
6466
/>
65-
<img
66-
src="/images/editor/visual-mode-dark.png"
67-
alt="Visual editing mode in the Mintlify Web Editor"
67+
68+
<img
69+
src="/images/editor/visual-mode-dark.png"
70+
alt="Visual editing mode in the Mintlify Web Editor"
6871
className="hidden dark:block"
6972
/>
7073
</Frame>
@@ -74,14 +77,15 @@ Visual Mode provides a rich WYSIWYG experience where you can see exactly how you
7477
Markdown Mode provides direct access to the underlying MDX code of your documentation. This mode is preferable when you need precise control over component properties or when you're comfortable with Markdown/MDX syntax.
7578

7679
<Frame>
77-
<img
78-
src="/images/editor/markdown-mode-light.png"
79-
alt="Markdown editing mode in the Mintlify Web Editor"
80+
<img
81+
src="/images/editor/markdown-mode-light.png"
82+
alt="Markdown editing mode in the Mintlify Web Editor"
8083
className="block dark:hidden"
8184
/>
82-
<img
83-
src="/images/editor/markdown-mode-dark.png"
84-
alt="Markdown editing mode in the Mintlify Web Editor"
85+
86+
<img
87+
src="/images/editor/markdown-mode-dark.png"
88+
alt="Markdown editing mode in the Mintlify Web Editor"
8589
className="hidden dark:block"
8690
/>
8791
</Frame>
@@ -93,23 +97,24 @@ Unlike the CLI where you need to know the exact syntax to add a component, the W
9397
To access the component menu, press the `/` key.
9498

9599
<Frame>
96-
<img
97-
src="/images/editor/component-menu-light.png"
98-
alt="Component menu in the Mintlify Web Editor"
99-
className="block dark:hidden"
100+
<img
101+
src="/images/editor/component-menu-light.png"
102+
alt="Component menu in the Mintlify Web Editor"
103+
className="block dark:hidden"
100104
/>
101-
<img
102-
src="/images/editor/component-menu-dark.png"
103-
alt="Component menu in the Mintlify Web Editor"
104-
className="hidden dark:block"
105+
106+
<img
107+
src="/images/editor/component-menu-dark.png"
108+
alt="Component menu in the Mintlify Web Editor"
109+
className="hidden dark:block"
105110
/>
106111
</Frame>
107112

108113
### Available Components
109114

110115
The component menu gives you access to all supported elements and components, including:
111116

112-
<CardGroup>
117+
<CardGroup cols={2}>
113118
<Card title="Basic blocks" icon="a-large-small" horizontal>
114119
Text, headings, blockquotes
115120
</Card>
@@ -144,18 +149,19 @@ The Web Editor provides an intuitive interface for making changes.
144149

145150
## Publishing
146151

147-
When you're ready to make your changes live, click the "Publish" button in the top-right corner to publish your changes.
152+
When you're ready to make your changes live, click the "Publish Pull Request" button in the top-right corner to publish your changes.
148153

149154
<Frame>
150-
<img
151-
src="/images/editor/publish-flow-light.png"
152-
alt="Publishing flow in the Mintlify Web Editor"
153-
className="block dark:hidden"
155+
<img
156+
src="/images/editor/publish-flow-light.png"
157+
alt="Publishing flow in the Mintlify Web Editor"
158+
className="block dark:hidden"
154159
/>
155-
<img
156-
src="/images/editor/publish-flow-dark.png"
157-
alt="Publishing flow in the Mintlify Web Editor"
158-
className="hidden dark:block"
160+
161+
<img
162+
src="/images/editor/publish-flow-dark.png"
163+
alt="Publishing flow in the Mintlify Web Editor"
164+
className="hidden dark:block"
159165
/>
160166
</Frame>
161167

@@ -190,23 +196,24 @@ When you are in a branch, you can make and save changes by clicking the "Save Ch
190196

191197
Pull requests provide a way to review changes before they're merged into your main documentation.
192198

193-
### Creating a Pull Request
199+
### Creating a Pull Request on a Branch
194200

195-
1. Make your changes on a feature branch
196-
2. Click the "Create Pull Request" button in the top-right corner
197-
3. Add a title and description for your pull request
198-
4. Click "Create Pull Request"
201+
1. Make your changes on a branch
202+
2. Click the "Publish Pull Request" button in the top-right corner
203+
3. Add a Pull Request Title and Description for your pull request
204+
4. Click "Publish Pull Request"
199205

200206
<Frame>
201-
<img
202-
src="/images/editor/pull-request-light.png"
203-
alt="Pull request creation in the Mintlify Web Editor"
204-
className="block dark:hidden"
207+
<img
208+
src="/images/editor/pull-request-light.png"
209+
alt="Pull request creation in the Mintlify Web Editor"
210+
className="block dark:hidden"
205211
/>
206-
<img
207-
src="/images/editor/pull-request-dark.png"
208-
alt="Pull request creation in the Mintlify Web Editor"
209-
className="hidden dark:block"
212+
213+
<img
214+
src="/images/editor/pull-request-dark.png"
215+
alt="Pull request creation in the Mintlify Web Editor"
216+
className="hidden dark:block"
210217
/>
211218
</Frame>
212219

@@ -225,13 +232,9 @@ The Web Editor seamlessly integrates with your Git repository, ensuring that all
225232
### How Git Sync Works
226233

227234
1. **Authentication**: The Web Editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab).
228-
229235
2. **Automatic Fetching**: When you open the editor, it automatically fetches the latest content from your repository's main branch.
230-
231236
3. **Change Tracking**: As you make edits in the Web Editor, changes are tracked and can be committed to your repository.
232-
233237
4. **Branching**: Changes can be made directly to your main branch or to a separate feature branch, depending on your workflow preferences.
234-
235238
5. **Pull Requests**: For collaborative workflows, you can create pull requests directly from the Web Editor.
236239

237240
## Git Terminology
@@ -241,80 +244,62 @@ While not necessary, understanding the following terms will help you work more e
241244
The following terms are used in the Web Editor and are also used in the Git workflow.
242245

243246
<AccordionGroup>
244-
245-
<Accordion title="Repository">
246-
247-
A repository (or "repo") is where your documentation files are stored, along with their revision history. The Web Editor connects to your Git repository to fetch and store documentation content.
248-
249-
</Accordion>
250-
251-
<Accordion title="Commit">
252-
253-
A commit is a snapshot of changes to your documentation at a specific point in time. When you publish changes in the Web Editor, you're creating a commit in your Git repository.
254-
255-
</Accordion>
256-
257-
<Accordion title="Branch">
258-
259-
A branch is a parallel version of your documentation that allows you to work on changes without affecting the main version. The Web Editor allows you to create and switch between branches.
260-
261-
</Accordion>
262-
263-
<Accordion title="Pull Request">
264-
265-
A pull request (PR) is a proposal to merge changes from one branch into another, typically from a feature branch into the main branch. PRs facilitate review and discussion before changes are incorporated.
266-
267-
</Accordion>
268-
269-
<Accordion title="Diff">
270-
271-
A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified.
272-
273-
</Accordion>
274-
247+
<Accordion title="Repository">
248+
A repository (or "repo") is where your documentation files are stored, along with their revision history. The Web Editor connects to your Git repository to fetch and store documentation content.
249+
</Accordion>
250+
<Accordion title="Commit">
251+
A commit is a snapshot of changes to your documentation at a specific point in time. When you publish changes in the Web Editor, you're creating a commit in your Git repository.
252+
</Accordion>
253+
<Accordion title="Branch">
254+
A branch is a parallel version of your documentation that allows you to work on changes without affecting the main version. The Web Editor allows you to create and switch between branches.
255+
</Accordion>
256+
<Accordion title="Pull Request">
257+
A pull request (PR) is a proposal to merge changes from one branch into another, typically from a feature branch into the main branch. PRs facilitate review and discussion before changes are incorporated.
258+
</Accordion>
259+
<Accordion title="Diff">
260+
A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified.
261+
</Accordion>
275262
</AccordionGroup>
276263

277264
## Troubleshooting
278265

279266
Here are solutions to common issues you might encounter with the Web Editor.
280267

281268
<AccordionGroup>
282-
<Accordion title="Changes Not Appearing After Publishing">
283-
284-
**Possible causes:**
285-
- Deployment is still in progress
286-
- Caching issues in your browser
269+
<Accordion title="Changes Not Appearing After Publishing">
270+
**Possible causes:**
287271

288-
**Solutions:**
289-
1. Check deployment status in your Mintlify Dashboard
290-
2. Try hard refreshing your browser (Ctrl+F5 or Cmd+Shift+R)
291-
3. Clear your browser cache
272+
- Deployment is still in progress
273+
- Caching issues in your browser
292274

293-
</Accordion>
275+
**Solutions:**
294276

295-
<Accordion title="Permission Errors When Publishing">
277+
1. Check deployment status in your Mintlify Dashboard
278+
2. Try hard refreshing your browser (Ctrl\+F5 or Cmd\+Shift\+R)
279+
3. Clear your browser cache
280+
</Accordion>
281+
<Accordion title="Permission Errors When Publishing">
282+
**Possible causes:**
296283

297-
**Possible causes:**
298-
- Insufficient permissions to the Git repository
299-
- Authentication issues with your Git provider
284+
- Insufficient permissions to the Git repository
285+
- Authentication issues with your Git provider
300286

301-
**Solutions:**
302-
1. Verify you have correct access to the repository
303-
2. Check if your Git integration is properly configured
304-
3. Review the [Editor Permissions](/advanced/dashboard/permissions) documentation
287+
**Solutions:**
305288

306-
</Accordion>
289+
1. Verify you have correct access to the repository
290+
2. Check if your Git integration is properly configured
291+
3. Review the [Editor Permissions](/advanced/dashboard/permissions) documentation
292+
</Accordion>
293+
<Accordion title="Editor Loading Issues">
294+
**Possible causes:**
307295

308-
<Accordion title="Editor Loading Issues">
296+
- Network connectivity problems
297+
- Large documentation repositories
309298

310-
**Possible causes:**
311-
- Network connectivity problems
312-
- Large documentation repositories
299+
**Solutions:**
313300

314-
**Solutions:**
315-
1. Check your internet connection
316-
2. Refresh the page and try again
317-
3. Contact support if the issue persists
318-
319-
</Accordion>
320-
</AccordionGroup>
301+
1. Check your internet connection
302+
2. Refresh the page and try again
303+
3. Contact support if the issue persists
304+
</Accordion>
305+
</AccordionGroup>

0 commit comments

Comments
 (0)