Skip to content

Commit 4afef6c

Browse files
committed
copyedit getting started
1 parent 4d5d2c2 commit 4afef6c

File tree

3 files changed

+24
-27
lines changed

3 files changed

+24
-27
lines changed

docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"pages": [
3131
"editor/getting-started",
3232
"editor/content-management",
33-
"editor/branching-workflow",
33+
"editor/branches",
3434
"editor/publishing",
3535
"editor/git-concepts",
3636
"editor/editor",
File renamed without changes.

editor/getting-started.mdx

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Getting started with the web editor"
33
sidebarTitle: "Getting started"
4-
description: "Learn how to use Mintlify's web editor to create and edit documentation"
4+
description: "Learn how to create and edit documentation with the web editor"
55
---
66

77
<img
@@ -16,57 +16,58 @@ description: "Learn how to use Mintlify's web editor to create and edit document
1616
alt="Mintlify web editor interface in dark mode"
1717
/>
1818

19-
The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser. No local setup required—just log in to your dashboard and start writing.
19+
The web editor is a visual interface for creating, editing, and reviewing documentation directly in your browser.
2020

21-
## What you can do
21+
- **Visual editing**: Make changes to your documentation using a what-you-see-is-what-you-get (WYSIWYG) editor that shows how your content will look when published.
22+
- **Git synchronization**: All changes automatically sync with your Git repository to maintain version control.
23+
- **Team collaboration**: Multiple people can work on documentation simultaneously.
24+
- **Component integration**: Add callouts, code blocks, and other components with slash commands.
25+
- **No setup required**: Start writing immediately from your dashboard.
2226

23-
- **Visual editing**: Make changes using a what-you-see-is-what-you-get (WYSIWYG) editor that shows how your content will look when published
24-
- **Git synchronization**: All changes automatically sync with your Git repository to maintain version control
25-
- **Real-time collaboration**: Multiple team members can work on documentation simultaneously
26-
- **Component integration**: Add callouts, code blocks, and other Mintlify components with a simple `/` command
27+
## Web editor workflow
2728

28-
## Your first editing session
29-
30-
Follow this walkthrough to make your first changes in the web editor:
29+
Here is how you'll typically work in the web editor:
3130

3231
<Steps>
3332
<Step title="Choose your branch">
34-
Create a branch or make changes directly to your deployment branch. For your first time, we recommend creating a branch to keep your live docs safe while you learn.
33+
Create a branch or make changes directly to your deployment branch. We recommend creating a branch so that you can preview your changes before they go live.
3534
</Step>
3635
<Step title="Open your file">
3736
Navigate to an existing file in the sidebar or create a new one using the file explorer.
3837
</Step>
3938
<Step title="Edit your content">
40-
Make changes in the web editor. Try switching between visual mode and Markdown mode using the toggle in the top-right corner to see which you prefer.
39+
Make changes in the web editor. Try switching between visual mode and Markdown mode using the toggle in the top-right corner to see which mode you prefer.
4140
</Step>
4241
<Step title="Preview your changes">
43-
Visual mode shows you exactly how your changes will appear on your live site. Use this to verify everything looks correct.
42+
Visual mode shows you how your changes will appear on your live site. Use this to verify everything looks correct.
4443
</Step>
4544
<Step title="Publish your changes">
46-
If you're working on your deployment branch, your changes go live immediately. On other branches, you'll create a pull request for review before publishing.
45+
If you're working on your deployment branch, publish your changes directly from the web editor. On other branches, you'll create a pull request for review before publishing.
4746
</Step>
4847
</Steps>
4948

5049
## Editor modes
5150

52-
The web editor offers two editing experiences. Switch between them anytime using the toggle in the editor toolbar:
51+
The web editor has two modes to accommodate different editing preferences and needs. Use the toggle in the top right corner of the editor toolbar to switch between editing modes.
5352

5453
<Frame>
5554
<img
5655
src="/images/editor/mode-toggle-light.png"
57-
alt="Mode toggle icons highlighted in the Mintlify web editor"
56+
alt="Mode toggle icons highlighted in the web editor."
5857
className="block dark:hidden"
5958
/>
6059
<img
6160
src="/images/editor/mode-toggle-dark.png"
62-
alt="Mode toggle icons highlighted in the Mintlify web editor"
61+
alt="Mode toggle icons highlighted in the web editor."
6362
className="hidden dark:block"
6463
/>
6564
</Frame>
6665

6766
### Visual mode
6867

69-
Perfect for beginners and quick edits. What you see in the editor is exactly what appears on your documentation site. Press `/` to open the component menu and add content blocks, callouts, and code snippets.
68+
Visual mode provides a WYSIWYG experience where the changes that you make in the editor are the changes that will be published to your documentation site. This mode is ideal for when you want to see how your changes will look in real-time.
69+
70+
Press `/` to open the component menu and add styled content, callouts, code snippets, or other components.
7071

7172
<Frame>
7273
<img
@@ -83,7 +84,7 @@ Perfect for beginners and quick edits. What you see in the editor is exactly wha
8384

8485
### Markdown mode
8586

86-
Gives you direct access to the underlying MDX code. Use this when you need precise control over component properties or prefer writing in Markdown syntax.
87+
Markdown mode provides direct access to the underlying `MDX` code of your documentation. This mode is ideal for when you need precise control over component properties or when you prefer to write in Markdown syntax.
8788

8889
<Frame>
8990
<img
@@ -100,10 +101,6 @@ Gives you direct access to the underlying MDX code. Use this when you need preci
100101

101102
## Next steps
102103

103-
Now that you understand the basics:
104-
105-
- Learn about [branching workflows](/editor/branching-workflow) for safer collaboration
106-
- Explore [content management](/editor/content-management) techniques
107-
- Understand [publishing options](/editor/publishing) for different scenarios
108-
109-
Need help? Check the [troubleshooting guide](/editor/troubleshooting) for common solutions.
104+
- Learn about collaborating with [branches](/editor/branches).
105+
- Explore [content management](/editor/content-management) techniques.
106+
- Understand [publishing options](/editor/publishing) for different scenarios.

0 commit comments

Comments
 (0)