ExplainMyRepo

overview.md

Reading an unfamiliar codebase is the slow part of every new project. ExplainMyRepo takes a GitHub URL and produces a plain-language explanation of the repository — how files are organised, what the key components do, and how the overall workflow fits together — so you can orient in minutes instead of an afternoon.

problem.txt

Onboarding into any repo means reverse-engineering intent from files. READMEs go stale, and a file tree tells you names, not meaning. I wanted the briefing a senior dev would give a newcomer, on demand.

architecture.drawio

1. Fetch — pull the repository contents via the GitHub API.
2. Parse — build a view of structure and key components.
3. Summarise — LLMs turn that into a human-readable walkthrough.
4. Present — structure + intent + workflow, in plain language.

challenges.log

• Keeping prompts within context limits on large repos.
• Separating signal (core modules) from noise (config, vendored code).
• Making explanations accurate, not confidently wrong.

lessons-learned.md

• Structure-first prompting beats dumping raw files at the model.
• The hard part of LLM tooling is retrieval and framing, not generation.
• Good developer UX is mostly about what you choose to leave out.

future-work.md

• Per-file deep dives on request.
• Diff-aware explanations for pull requests.
• Local model option for private repos.