Repo Explainer

Repo Explainer is a Chrome extension that helps first-time contributors understand a GitHub repo fast. It analyzes repository metadata, structure, and key files, then generates a guided explanation with:

• Summary and architecture breakdown
• First 30 minutes onboarding steps
• Key files to read (with rationale)
• Interactive file tree + “where to start” guidance
• Diagram view for repo flow

Install

1. Clone this repository.
2. Open Chrome and go to chrome://extensions.
3. Enable Developer mode (top-right).
4. Click Load unpacked.
5. Select: repo-explainer/extension

Configure API Keys

1. Click the extension icon, then Options.
2. Set:
   • OpenAI API Key (required)
   • GitHub Token (optional but strongly recommended to avoid stricter rate limits)
3. Save.

How To Use

Option A: From the popup (works on any page)

1. Open the extension popup.
2. Paste a GitHub repo URL (or owner/repo).
3. Choose options:
   • Mermaid diagram: include architecture diagram
   • Contribute tips: include practical contribution guidance
   • Whole repo review (slower): deeper analysis across more files
4. Click Explain.
5. A full result page opens in a new tab.

Option B: Directly on GitHub repo pages

1. Open any repository page on github.com.
2. Use the injected Explain this repo button.
3. Optionally enable Full repo beside the button for deeper analysis.
4. Wait for progress status updates; the result opens automatically.

Reading The Result Page

• Overview: what the project is and why it exists
• Architecture: grouped runtime/system components
• Getting Started: first actions for new contributors
• Key Files: high-value files with direct links
• File Tree: searchable tree with focus controls and key-path highlighting
• Diagram: architecture flow + explanation legend