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
+28-4Lines changed: 28 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ Here is how you'll typically work in the web editor:
42
42
Visual mode shows you how your changes will appear on your live site. Use this to verify everything looks correct.
43
43
</Step>
44
44
<Steptitle="Publish your changes">
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.
45
+
Publish your changes directly to your live documentation site or create a pull request to review changes before merging.
46
46
</Step>
47
47
</Steps>
48
48
@@ -248,10 +248,18 @@ See [Format text](/create/text) and [Format code](/create/code) for more informa
248
248
249
249
## Publish your changes
250
250
251
-
The branch that you work on determines how the editor publishes your changes:
251
+
The editor's publishing workflow depends on which branch you work on and your repository's branch protection rules.
252
252
253
-
-**Deployment branch**: Publishing updates your live site immediately.
254
-
-**Other branches**: Publishing creates a pull request so you can review changes before deploying them to production.
253
+
| Branch type | Branch protection | What happens when you publish |
| Deployment branch | None | Changes merge and are live immediately |
256
+
| Deployment branch | Pull requests required | Creates a pull request for review |
257
+
| Other branch | None | Changes merge into deployment branch and are live immediately |
258
+
| Other branch | Pull requests required | Creates a pull request for review |
259
+
260
+
<Tip>
261
+
Configure branch protection rules in your Git provider to require pull request reviews before merging. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub docs or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab docs for more information.
262
+
</Tip>
255
263
256
264
<Frame>
257
265
<img
@@ -324,6 +332,22 @@ Once your pull request is created:
324
332
4.**Approve**: Approve the pull request when you're satisfied with the changes.
325
333
5.**Merge**: Merge the pull request when you're ready to deploy your changes to production.
326
334
335
+
### Share preview deployments
336
+
337
+
Share preview deployments with your team to gather feedback before you publish changes.
338
+
339
+
1. Click the **Share** button in the editor toolbar.
340
+
1. Click the **Preview** button to open the preview deployment in a new browser tab.
341
+
<Frame>
342
+
<imgsrc="/images/editor/share-preview-light.png"alt="Share preview panel opened in the editor toolbar."className="block dark:hidden" />
343
+
<imgsrc="/images/editor/share-preview-dark.png"alt="Share preview panel opened in the editor toolbar."className="hidden dark:block" />
344
+
</Frame>
345
+
1. Share the preview URL with anyone who needs to review your changes.
346
+
347
+
When you make changes, the preview deployment updates automatically. Changes may take a short time to appear.
348
+
349
+
Preview URLs are publicly accessible by default. Anyone with the link can view your preview deployment. To restrict access to authenticated members of your organization, enable preview authentication in your [dashboard](https://dashboard.mintlify.com/products/addons).
350
+
327
351
## Keyboard shortcuts
328
352
329
353
The web editor supports all common keyboard shortcuts such as copy, paste, undo, and select all, and the following shortcuts:
0 commit comments