Skip to content

Commit 81bb2d3

Browse files
committed
update PR section
1 parent 7f888ea commit 81bb2d3

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

editor.mdx

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -257,63 +257,64 @@ This example shows how to add a Themes page to the Profile group.
257257
}
258258
```
259259

260-
## Pull Requests and reviewing changes
261-
262-
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.
260+
## Publishing changes
263261

264-
See how your changes will appear in visual mode.
262+
Select the **Publish** button to save your changes and make them available.
265263

266-
### Creating a Pull Request on a Branch
264+
How your changes are published depends on which branch you are working on:
267265

268-
1. Make your changes on a branch.
269-
2. Click the **Publish Pull Request** button in the top-right corner of the editor.
270-
3. Add a Pull Request Title and Description for your pull request. A good title and description will help reviewers understand the changes you've made.
271-
4. Click **Publish Pull Request**.
266+
* **Deployment branch**: Updates your live site immediately.
267+
* **Other branches**: Creates a pull request so you can review changes before they go live.
272268

273269
<Frame>
274270
<img
275-
src="/images/editor/pull-request-light.png"
276-
alt="Publish pull request button emphasized in the Mintlify web editor"
271+
src="/images/editor/publish-flow-light.png"
272+
alt="The publish button emphasized in the Mintlify web editor"
277273
className="block dark:hidden"
278274
/>
279275
<img
280-
src="/images/editor/pull-request-dark.png"
281-
alt="Publish pull request button emphasized in the Mintlify web editor"
276+
src="/images/editor/publish-flow-dark.png"
277+
alt="The publish button emphasized in the Mintlify web editor"
282278
className="hidden dark:block"
283279
/>
284280
</Frame>
285281

286-
### Reviewing Pull Requests
287-
288-
You can review pull requests in your Git platform (GitHub, GitLab).
289-
290-
After you create a pull request, you can see a preview deployment of the changes.
291-
292-
After a reviewer approves a pull request, you can merge it to deploy the changes to your live documentation site.
293-
282+
## Pull Requests and reviewing changes
294283

295-
## Publishing changes
284+
Pull requests (PRs) let you propose changes from your branch so that other people can review them before merging into your live documentation. This helps ensure that your changes are correct and gives your team a chance to collaborate on content.
296285

297-
Select the **Publish** button to publish your changes to your live documentation site.
286+
### Creating a pull request on a branch
298287

299-
The **Publish** button works differently depending on your branch:
288+
When you're ready to publish changes from your branch:
300289

301-
* **Deployment branch**: Updates your live site immediately. This is usually the `main` branch.
302-
* **Other branches**: Creates a pull request for review.
290+
1. Make sure all your changes are saved on your branch.
291+
1. Select **Publish Pull Request** in the top-right corner of the editor.
292+
1. Add a title and description for your pull request. A good title and description help reviewers understand the changes you've made.
293+
1. Select **Publish Pull Request**.
303294

304295
<Frame>
305296
<img
306-
src="/images/editor/publish-flow-light.png"
307-
alt="The publish button emphasized in the Mintlify web editor"
297+
src="/images/editor/pull-request-light.png"
298+
alt="Publish pull request button emphasized in the Mintlify web editor"
308299
className="block dark:hidden"
309300
/>
310301
<img
311-
src="/images/editor/publish-flow-dark.png"
312-
alt="The publish button emphasized in the Mintlify web editor"
302+
src="/images/editor/pull-request-dark.png"
303+
alt="Publish pull request button emphasized in the Mintlify web editor"
313304
className="hidden dark:block"
314305
/>
315306
</Frame>
316307

308+
The web editor will create a pull request in your Git repository and provide a link to view it.
309+
310+
### Reviewing pull requests
311+
312+
Once your pull request is created:
313+
314+
1. **Review your changes**: You and your team members can review your pull request in your Git provider like GitHub or GitLab.
315+
1. **Make additional changes**: After reviewing, make any changes in your web editor. Saving your changes will update your pull request.
316+
1. **Merge when ready**: When your pull request is ready, merge it to deploy changes to your live documentation site.
317+
317318
## Troubleshooting
318319

319320
Here are solutions to common issues you might encounter with the web editor.

0 commit comments

Comments
 (0)