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: editor.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,7 +114,7 @@ Markdown mode provides direct access to the underlying MDX code of your document
114
114
115
115
The **Publish** button works differently depending on your branch:
116
116
117
-
***Main branch**: Updates your live site immediately.
117
+
***Deployment branch**: Updates your live site immediately.
118
118
***Other branches**: Creates a pull request for review.
119
119
120
120
<Frame>
@@ -132,7 +132,7 @@ The **Publish** button works differently depending on your branch:
132
132
133
133
## Branches
134
134
135
-
Branches allow you to work on documentation changes without updating the main version until you're ready for your changes to go live.
135
+
Branches allow you to safely work on changes without affecting your live documentation. When your changes are ready, you can merge them into your deployment branch and make them live.
136
136
137
137
<Tip>
138
138
Use branches for significant updates, new sections, or when multiple team members are working on different parts of the documentation simultaneously.
@@ -158,7 +158,7 @@ When you are working on a branch, your changes are not automatically saved.
158
158
159
159
## Pull Requests
160
160
161
-
Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your main documentation.
161
+
Pull requests (or PRs) let you and other people review changes that you've made on a branch and then merge those changes into your documentation.
162
162
163
163
### Creating a Pull Request on a Branch
164
164
@@ -186,7 +186,7 @@ You can review pull requests in your Git platform (GitHub, GitLab).
186
186
187
187
After you create a pull request, you can see a preview deployment of the changes.
188
188
189
-
After a reviewer approves a pull request, you can merge the pull request into your main branch and the changes will be deployed to your live documentation site.
189
+
After a reviewer approves a pull request, you can merge it to deploy the changes to your live documentation site.
190
190
191
191
## Git Synchronization
192
192
@@ -196,11 +196,11 @@ The web editor integrates with your Git repository, ensuring that all changes ar
196
196
197
197
***Authentication**: The web editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab).
198
198
199
-
***Automatic fetching**: When you open the editor, it automatically fetches the latest content from your repository's main branch.
199
+
***Automatic fetching**: When you open the editor, it automatically fetches the latest content from your repository's deployment branch.
200
200
201
201
***Change tracking**: As you make edits, the web editor tracks changes and can commit them to your repository.
202
202
203
-
***Branching**: You can make changes directly to your main branch or to a separate branch, depending on your workflow preferences.
203
+
***Branching**: You can make changes directly to your deployment branch or to a separate branch, depending on your workflow preferences.
204
204
205
205
***Pull requests**: For collaborative workflows, you can create pull requests from the web editor.
206
206
@@ -224,7 +224,7 @@ A commit is a snapshot of changes to your documentation at a specific point in t
224
224
225
225
<Accordiontitle="Branch">
226
226
227
-
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.
227
+
A branch is a parallel version of your documentation that allows you to work on changes without affecting the live version. The web editor allows you to create and switch between branches.
0 commit comments