Skip to content

Commit ed5e103

Browse files
committed
copyedit publishing
1 parent 76ae474 commit ed5e103

File tree

1 file changed

+27
-76
lines changed

1 file changed

+27
-76
lines changed

editor/publishing.mdx

Lines changed: 27 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,12 @@
11
---
22
title: "Publishing your changes"
3-
description: "Deploy your documentation updates directly or through pull requests"
3+
description: "Deploy your documentation updates directly to production or through pull requests"
44
---
55

6-
The web editor offers two publishing paths depending on which branch you're working on: direct publishing to your live site or pull request workflows for review.
6+
How your changes are published depends on which branch you are working on:
77

8-
## Publishing workflows
9-
10-
### Direct publishing (deployment branch)
11-
When working on your deployment branch (usually `main`):
12-
13-
1. Make your changes in the editor
14-
2. Select **Publish** in the top-right corner
15-
3. Your changes deploy immediately to your live documentation site
16-
17-
**Use this for**: Quick fixes, typos, and urgent updates when you're confident in your changes.
18-
19-
### Pull request workflow (feature branches)
20-
When working on any other branch:
21-
22-
1. Make and save your changes
23-
2. Select **Publish Pull Request**
24-
3. Add a title and description for review
25-
4. Create the pull request for team review
26-
5. Merge when approved to deploy to your live site
27-
28-
**Use this for**: New features, major content updates, and collaborative work that benefits from review.
8+
* **Deployment branch**: Publishing updates your live site immediately.
9+
* **Other branches**: Publishing creates a pull request so you can review changes before they are deployed to production.
2910

3011
<Frame>
3112
<img
@@ -40,29 +21,33 @@ When working on any other branch:
4021
/>
4122
</Frame>
4223

43-
## Creating a pull request
24+
## Pull requests and reviewing changes
25+
26+
Pull requests 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.
27+
28+
<Tip>
29+
Even if you're working solo, pull requests are valuable for previewing changes and maintaining a clear history of updates.
30+
</Tip>
4431

45-
When you're ready to publish changes from a feature branch:
32+
### Creating a pull request
4633

4734
<Steps>
4835
<Step title="Save your work">
4936
Make sure all your changes are saved on your branch using **Save Changes**.
5037
</Step>
51-
<Step title="Start the pull request">
38+
<Step title="Create the pull request">
5239
Select **Publish Pull Request** in the top-right corner of the editor.
5340
</Step>
54-
<Step title="Add context">
41+
<Step title="Add a title and description">
5542
Write a clear title and description explaining:
5643
- What changes you made
57-
- Why you made them
44+
- Why you made them
5845
- Any specific areas that need review
5946
</Step>
6047
<Step title="Create and share">
61-
Select **Publish Pull Request**. The editor will provide a link to view your pull request in GitHub or GitLab.
62-
</Step>
63-
</Steps>
48+
Select **Publish Pull Request**. The editor will provide a link to view your pull request.
6449

65-
<Frame>
50+
<Frame>
6651
<img
6752
src="/images/editor/pull-request-light.png"
6853
alt="Publish pull request button emphasized in the Mintlify web editor"
@@ -73,50 +58,16 @@ When you're ready to publish changes from a feature branch:
7358
alt="Publish pull request button emphasized in the Mintlify web editor"
7459
className="hidden dark:block"
7560
/>
76-
</Frame>
77-
78-
## Review and approval process
79-
80-
### For reviewers
81-
Once a pull request is created:
82-
83-
1. **Review changes**: Check the diff in GitHub or GitLab to see exactly what changed
84-
2. **Test locally**: Pull the branch locally if you want to test changes
85-
3. **Leave feedback**: Add comments or request changes if needed
86-
4. **Approve**: Approve the pull request when you're satisfied with the changes
87-
88-
### For authors
89-
After creating your pull request:
90-
91-
1. **Address feedback**: Make additional changes in the web editor if reviewers request them
92-
2. **Update automatically**: Saving changes in the editor automatically updates your pull request
93-
3. **Merge when ready**: Once approved, merge your pull request to deploy changes
94-
95-
<Tip>
96-
Even if you're working solo, pull requests are valuable for previewing changes and maintaining a clear history of updates.
97-
</Tip>
98-
99-
## Best practices
100-
101-
### Writing good pull request descriptions
102-
- Explain the **why** behind your changes, not just the what
103-
- Include screenshots for visual changes
104-
- List any breaking changes or considerations for reviewers
105-
- Reference related issues or tickets if applicable
106-
107-
### Choosing the right workflow
108-
- **Direct publish** for: Typo fixes, minor updates, emergency changes
109-
- **Pull requests** for: New content, restructuring, collaborative work, experimental features
110-
111-
### Managing multiple changes
112-
- Keep pull requests focused on a single feature or fix
113-
- Create separate branches for unrelated changes
114-
- Merge or close old pull requests before starting new major work
115-
116-
## Troubleshooting publishing
61+
</Frame>
62+
</Step>
63+
</Steps>
11764

118-
**Changes not appearing**: Check your deployment status in the Mintlify dashboard and try hard refreshing your browser.
65+
## Reviewing pull requests
11966

120-
**Permission errors**: Verify you have the correct repository access and that your Git integration is properly configured.
67+
Once your pull request is created:
12168

122-
**Merge conflicts**: If someone else changed the same content, you may need to resolve conflicts in your Git provider before merging.
69+
1. **Review changes**: You and your team members can review your pull request in your Git provider like GitHub or GitLab.
70+
2. **Leave feedback**: Add comments or request changes.
71+
3. **Make additional changes**: Make additional changes in the web editor. When you save changes, the editor pushes them to your pull request.
72+
4. **Approve**: Approve the pull request when you're satisfied with the changes.
73+
5. **Merge**: Merge the pull request when you're ready to deploy your changes to production.

0 commit comments

Comments
 (0)