Generate repo docs

Overview

Generate repo docs turns your GitHub repository into clear, reader‑friendly pages you can browse, search, and share. It indexes your source files, groups the results into collections, and adds source citations so you know where each page came from. You can run indexing on demand or let it run on a schedule, then verify pages are up to date and ready for your team or for publishing.

When to use it

• You need fresh documentation from a selected repository on demand.
• You want to understand how pages are grouped into collections.
• You need to see which source files a page cites.
• You want to confirm pages are current after recent code changes.

How to use it

1. Open Dashboard → Docs for your selected repository.
2. Start indexing by clicking Run indexing. This creates or refreshes pages from your latest code.
3. Wait for the background job to finish. You can navigate away; results appear when indexing completes.
4. Browse the generated pages. Use the left navigation to see collections such as Get started, Architecture, or Backend.
5. Search within the repo docs to find topics or files by name.
6. Open any page to review its content. Confirm it reads clearly and matches the latest code behavior.
7. Check source citations on the page to see which source files informed that content.
8. Re‑run indexing after changes by returning to Dashboard → Docs and clicking Run indexing again.
9. Verify freshness by opening recently updated pages and confirming their citations and content reflect the latest commit.

Re‑run on a schedule

1. Open Dashboard → Docs for the repository.
2. Confirm that scheduled indexing is enabled if available. When enabled, Moxie Docs will refresh pages automatically on the set schedule.
3. Manually run indexing any time you need an immediate refresh, even if a schedule exists.

Options and settings

• Run indexing: Triggers an immediate background job to (re)generate pages.
• Collections: Groups pages by theme (for example, Get started, Architecture, Backend) for easier navigation.
• Source citations: Shows which source files contributed to each page.
• Scheduled indexing (if enabled for your repo): Automatically refreshes pages on a defined cadence.

Tips

• If a page looks outdated, re‑run indexing first, then refresh your browser before reviewing again.
• Use collections to spot gaps: if a collection is empty after indexing, consider adding relevant source content to your repo and re‑running.
• Source citations help with trust: check them when content feels unexpected or unclear.
• You can run indexing as often as you need; recent runs replace older content for the same repository.