Files
Tutorial-Codebase-Knowledge/README.md
zachary62 2ebad5e5f2 init push
2025-04-04 13:03:54 -04:00

25 lines
1006 B
Markdown

<h1 align="center">Turns Codebase into Easy Tutorial</h1>
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
<p align="center">
<i>Ever stared at a new codebase written by others feeling completely lost? This tutorial shows you how to build an AI agent that analyzes GitHub repositories and creates beginner-friendly tutorials explaining exactly how the code works.</i>
</p>
<p align="center">
<a href="https://github.com/The-Pocket/PocketFlow" target="_blank">
<img
src="./assets/banner.png" width="800"
/>
</a>
</p>
This project crawls GitHub repositories and build a knowledge base from the code:
- **Analyze entire codebases** to identify core abstractions and how they interact
- **Transform complex code** into beginner-friendly tutorials with clear visualizations
- **Build understanding systematically** from fundamentals to advanced concepts in logical steps
Built with [Pocket Flow](https://github.com/The-Pocket/PocketFlow), a 100-line LLM framework.