Connect GitHub

Overview

Connect your GitHub account and select repositories so Moxie Docs can read source code, generate readable documentation, and keep it current with docs‑only pull requests. After setup, you can sign in with GitHub, choose which repos Moxie can access, and verify that docs and PRs are flowing. You can later adjust access or disconnect at any time.

Before you start

• A GitHub account.
• Permission to install apps on the target GitHub account or organization (Owner or App installation permission).
• The repositories you want Moxie Docs to work with are hosted on GitHub.

Connect

1. Go to the Moxie marketing site and click "Sign in with GitHub".
2. Authorize GitHub if prompted. Review the access screen and click "Authorize" to continue.
3. In the Moxie Dashboard first‑run flow, click "Install the Moxie GitHub App" when prompted.
4. On the GitHub "Install App" screen, choose where to install:
   • Select your personal account or an organization.
   • Click "Install" to proceed.
5. On the "Repository access" step, choose which repos Moxie can access:
   • Select "All repositories" to grant access to every repo under the account, or
   • Select "Only select repositories" and check each repo you want Moxie to use.
   • Click "Save" or "Install" to confirm (label varies by GitHub screen).
6. When GitHub redirects back to Moxie, confirm the workspace you want to link and click "Continue". Your selected repositories will appear in the Dashboard.

Configure

After connecting, set how Moxie Docs works with your repos:

• Repositories: Choose which connected repos should be active for docs generation in your workspace.
• Docs updates: Allow Moxie to open docs‑only pull requests that update generated documentation.
• Search visibility: Make generated docs searchable for your team inside Moxie.
• Public knowledge base: Optionally publish approved pages to a public knowledge base when you’re ready.
• AI access: Enable repo context for AI agents via MCP so assistants can reference your codebase.

Verify it works

• In the Moxie Dashboard, confirm your selected repositories show as "Connected" or listed under your workspace.
• In GitHub, open one of the selected repositories and check the "Settings" > "Integrations" > "GitHub Apps" (or "Installed GitHub Apps") to see "Moxie" installed for that repo.
• In GitHub, check the "Pull requests" tab for a recent docs‑only PR created by Moxie after your first sync (allow a few minutes).
• In Moxie Docs, search for a term from your codebase and confirm results appear from the connected repository.

Disconnect or change access

• To change which repos Moxie can access: In GitHub, go to your account or organization "Settings" > "Integrations" > "GitHub Apps" > "Moxie" > "Configure". Update "Repository access" to add or remove repositories, then save. The changes apply in Moxie after a short sync.
• To remove the app entirely: In the same GitHub "Moxie" configuration page, choose "Uninstall". This revokes access and stops new docs‑only PRs.
• To pause a repo in Moxie without uninstalling: In the Moxie Dashboard, open the repository list for your workspace and disable or deselect the repo you no longer want processed.
• After changing access, return to Moxie and refresh the Dashboard to confirm the current connection status.