Docs‑only PRs

Overview

Docs‑only PRs let Moxie propose documentation changes to your connected GitHub repository as standard pull requests. You review, adjust, and merge these changes just like any other PR in GitHub. Moxie adds GitHub Checks and advisory comments to guide your review and follows your repository’s chosen mode (conservative or suggest) until you fully enable automated updates. Once merged, your approved docs become searchable in Moxie and can be published to your knowledge base.

When to use it

• Keep documentation current as your code evolves without editing files by hand.
• Centralize review in GitHub so your team can comment and approve in a familiar workflow.
• Safely trial Moxie’s suggestions with checks and advisory comments before merging.
• Build a trusted source of truth that becomes searchable for your team after approval.

How to use it

1. Connect your GitHub repository to Moxie Docs in the dashboard. This lets Moxie open docs‑only pull requests in that repo.
2. Open the GitHub pull request created by Moxie. Look for a PR titled with the proposed documentation update in your repo’s "Pull requests" tab.
3. Review the changes in the "Files changed" tab. Confirm that only documentation content is modified and that the edits match your project’s style.
4. Read the GitHub Checks and advisory comments added by Moxie. These appear in the PR conversation and checks panels to explain what changed and why.
5. Discuss with your team using GitHub comments. Request edits if needed by leaving comments on specific lines.
6. Adjust the PR if changes are suggested. Moxie will update the same PR safely when it posts a follow‑up commit, keeping the history in one place.
7. Approve the PR using GitHub’s "Approve" review when the documentation looks right.
8. Merge the PR in GitHub. Use your normal merge option. Moxie respects your repository’s mode and any branch protection rules you have.
9. Confirm the update in Moxie. After merge, open Moxie Docs to see the new documentation reflected in search and, if enabled, your public knowledge base.

Options and settings

• Repository mode: Moxie respects conservative or suggest modes until you fully enable it for the repo. In these modes, changes arrive as reviewable PRs with guidance, not auto‑merges.
• GitHub Checks: Moxie adds checks to each PR to summarize what changed and flag anything that needs attention.
• Advisory comments: Moxie posts context and suggestions in the PR conversation to help reviewers understand the edits.

Tips

• If you want further tweaks, comment in the PR; Moxie will update the same PR rather than opening new ones.
• Use GitHub’s required reviews and branch protections as usual; Moxie follows your existing repo settings.
• Skim the checks summary first to spot scope, page count, and any advisories before reading line‑by‑line.