Configure PR automation and detectors

Overview

This guide helps you tune how Moxie Docs surfaces documentation drift and how those findings become clear, low‑noise pull requests in your GitHub repository. After setup, you can review focused suggestions, preview changes, and create PRs that update or remove outdated docs with confidence.

Before you start

• A connected GitHub repository that Moxie Docs can read and open pull requests against.
• Access to the Moxie Docs dashboard for your workspace.
• Permission in your GitHub repo to create branches and pull requests.

Connect

1. Open the Moxie Docs dashboard and go to your documentation collections.
2. Confirm your GitHub repository is connected. If the repo is not connected yet, follow the GitHub connection prompt shown in the dashboard to authorize access so Moxie Docs can create pull requests.
3. Wait for the initial index to finish so documentation pages appear in search and drift review.

Configure

Use drift review and search to focus findings and shape PRs before you create them.

• Use the search bar on Docs Home or any collection view to find pages and drift by keyword. Empty searches return no results, so enter a term related to the area you want to update.
• In drift review, look at each finding’s type and severity to decide whether to act now or later.
• For items you do not want to see again, dismiss or mute them to reduce noise in future review sessions.
• When a suggested PR appears, open it to preview the exact documentation changes before creating the PR in GitHub.
• For outdated docs that should be removed instead of updated, choose the option to remove outdated docs when reviewing suggestions so the PR focuses on deletions.
• Keep the list of suggested and open PRs short by regularly dismissing low‑value items and acting on high‑severity findings.

Verify it works

• You can search for a topic and see relevant documentation pages along with drift findings by type and severity.
• The drift review shows suggested PRs that you can open and preview.
• Creating a PR from the preview results in a new pull request in your GitHub repository.
• Dismissing or muting an item removes it from your active review list on refresh.

Disconnect or change access

• To stop creating documentation PRs from Moxie Docs, revoke its access in your GitHub account and remove the repository connection in the Moxie Docs dashboard.
• If you need to switch repositories, disconnect the current repo in the dashboard, then connect the new GitHub repo and allow indexing to complete before reviewing drift again.