Activate and index a repo

Overview

Activate Docs to turn a connected GitHub repository into an organized, searchable knowledgebase. Use the first‑index view to start the initial index, watch progress in real time, and run or cancel jobs as needed. When indexing completes, you can browse collections, search generated pages, and use drift findings to keep docs fresh.

When to use it

• You connected a GitHub repository and want Docs to generate pages for the first time.
• You need to queue and run the first indexing job after activation.
• You want to monitor indexing status and see when content is ready.
• You need to re‑run a queued job once to finish setup.

How to use it

1. Open the repository in Moxie Docs. If the repo has no docs yet, you’ll see the first‑index view with a Status header.
2. Click “Activate Repo” to enable Docs for this repository. If you don’t have permission, you’ll see a link to repository settings so someone with the right access can activate it.
3. Click “Activate & Queue” to both activate and place the first index in the queue. This prepares the job to run. If the repo is already activated, you may only see queue and run controls.
4. Click “Run queued job once” to start the first index. The Status header auto‑refreshes while the job is queued or running.
5. Watch the Status header for live updates. Stay on the page while it auto‑refreshes; you can come back later if needed.
6. Wait for indexing to complete. When done, browse collections and search across generated pages from the dashboard. Review drift findings to spot outdated docs and create PRs to update them.
7. Re‑run if needed. If the job is still queued or you need a single fresh run, click “Run queued job once” again. If you don’t have access to run jobs, follow the on‑screen link to repository settings or contact a manager.

Choose the indexing branch

By default, Moxie Docs indexes and generates documentation from your repository’s default branch on GitHub (usually main). If your team develops on a separate branch—such as develop or staging—you can point Moxie at that branch instead, without changing your repository’s default on GitHub.

1. Open Settings → Repositories in the Dashboard.
2. Find the repository and click the Indexing branch control beneath its name.
3. Enter the branch you want Moxie to read from, then Save. Leave the field empty to follow the default branch again.

When an indexing branch is set, everything Moxie reads and writes follows it: the source it documents, the files you browse and open on GitHub, inline documentation edits, and the base branch of every documentation pull request. Pushes to that branch trigger re‑indexing, just as pushes to the default branch normally would. Only workspace owners and admins can change the indexing branch, and the branch must already exist in the repository.

Options and settings

• Status header: shows current first‑index status and live updates.
• “Activate Repo”: enables Docs for the connected repository.
• “Activate & Queue”: activates the repo and places the first indexing job in the queue.
• “Run queued job once”: starts a single run of the queued indexing job.
• Indexing branch: choose which branch Moxie reads and documents; leave empty to follow the repository’s default branch. Documentation pull requests open against the branch you choose.
• Permission‑aware prompts: managers see activation controls; members without permission see a link to repository settings.
• Billing‑aware actions: some buttons may be unavailable if your plan does not allow activation or runs.

Tips

• Stay on the first‑index view to watch progress; it auto‑refreshes while work is queued or running.
• If you can’t see “Activate Repo,” you likely lack permission—use the repository settings link shown on the page or ask a manager.
• After the first index completes, use drift findings to quickly prioritize doc updates before re‑running a job.
• You can return to the repo later; the Status header will reflect the latest state when you reopen it.