update readme

zachary62 · zachary62 · commit 180e0d9f6786 · 2025-04-04T17:29:26.000-04:00
diff --git a/docs/AutoGen Core/index.md b/docs/AutoGen Core/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: AutoGen Core
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 AutoGen Core helps you build applications with multiple **_Agents_** that can work together.
 Think of it like creating a team of specialized workers (*Agents*) who can communicate and use tools to solve problems.
 The **_AgentRuntime_** acts as the manager, handling messages and agent lifecycles.
diff --git a/docs/Browser Use/index.md b/docs/Browser Use/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: Browser Use
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 **Browser Use** is a project that allows an *AI agent* to control a web browser and perform tasks automatically.
 Think of it like an AI assistant that can browse websites, fill forms, click buttons, and extract information based on your instructions. It uses a Large Language Model (LLM) as its "brain" to decide what actions to take on a webpage to complete a given *task*. The project manages the browser session, understands the page structure (DOM), and communicates back and forth with the LLM.
 
diff --git a/docs/Celery/index.md b/docs/Celery/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: Celery
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 Celery is a system for running **distributed tasks** *asynchronously*. You define *units of work* (Tasks) in your Python code. When you want a task to run, you send a message using a **message broker** (like RabbitMQ or Redis). One or more **Worker** processes are running in the background, listening for these messages. When a worker receives a message, it executes the corresponding task. Optionally, the task's result (or any error) can be stored in a **Result Backend** (like Redis or a database) so you can check its status or retrieve the output later. Celery helps manage this whole process, making it easier to handle background jobs, scheduled tasks, and complex workflows.
 
 
diff --git a/docs/Click/index.md b/docs/Click/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: Click
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 Click is a Python library that makes creating **command-line interfaces (CLIs)** *easy and fun*.
 It uses simple Python **decorators** (`@click.command`, `@click.option`, etc.) to turn your functions into CLI commands with options and arguments.
 Click handles parsing user input, generating help messages, validating data types, and managing the flow between commands, letting you focus on your application's logic.
diff --git a/docs/Crawl4AI/index.md b/docs/Crawl4AI/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: Crawl4AI
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 `Crawl4AI` is a flexible Python library for *asynchronously crawling websites* and *extracting structured content*, specifically designed for **AI use cases**.
 You primarily interact with the `AsyncWebCrawler`, which acts as the main coordinator. You provide it with URLs and a `CrawlerRunConfig` detailing *how* to crawl (e.g., using specific strategies for fetching, scraping, filtering, and extraction).
 It can handle single pages or multiple URLs concurrently using a `BaseDispatcher`, optionally crawl deeper by following links via `DeepCrawlStrategy`, manage `CacheMode`, and apply `RelevantContentFilter` before finally returning a `CrawlResult` containing all the gathered data.
diff --git a/docs/CrewAI/index.md b/docs/CrewAI/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: CrewAI
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 **CrewAI** is a framework for orchestrating *autonomous AI agents*.
 Think of it like building a specialized team (a **Crew**) where each member (**Agent**) has a role, goal, and tools.
 You assign **Tasks** to Agents, defining what needs to be done. The **Crew** manages how these Agents collaborate, following a specific **Process** (like sequential steps).
diff --git a/docs/DSPy/index.md b/docs/DSPy/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: DSPy
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 DSPy helps you build and optimize *programs* that use **Language Models (LMs)** and **Retrieval Models (RMs)**.
 Think of it like composing Lego bricks (**Modules**) where each brick performs a specific task (like generating text or retrieving information).
 **Signatures** define what each Module does (its inputs and outputs), and **Teleprompters** automatically tune these modules (like optimizing prompts or examples) to get the best performance on your data.
diff --git a/docs/FastAPI/index.md b/docs/FastAPI/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: FastAPI
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 FastAPI is a modern, *high-performance* web framework for building APIs with Python.
 It's designed to be **easy to use**, fast to code, and ready for production.
 Key features include **automatic data validation** (using Pydantic), **dependency injection**, and **automatic interactive API documentation** (OpenAPI and Swagger UI).
diff --git a/docs/Flask/index.md b/docs/Flask/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: Flask
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 Flask is a lightweight **web framework** for Python.
 It helps you build web applications by handling incoming *web requests* and sending back *responses*.
 Flask provides tools for **routing** URLs to your Python functions, managing *request data*, creating *responses*, and using *templates* to generate HTML.
diff --git a/docs/LangGraph/index.md b/docs/LangGraph/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: LangGraph
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 LangGraph helps you build complex **stateful applications**, like chatbots or agents, using a *graph-based approach*.
 You define your application's logic as a series of steps (**Nodes**) connected by transitions (**Edges**) in a **Graph**.
 The system manages the application's *shared state* using **Channels** and executes the graph step-by-step with its **Pregel engine**, handling things like branching, interruptions, and saving progress (**Checkpointing**).
diff --git a/docs/LevelDB/index.md b/docs/LevelDB/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: LevelDB
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 LevelDB is a fast *key-value storage library* written at Google.
 Think of it like a simple database where you store pieces of data (values) associated with unique names (keys).
 It's designed to be **very fast** for both writing new data and reading existing data, and it reliably stores everything on **disk**.
diff --git a/docs/MCP Python SDK/index.md b/docs/MCP Python SDK/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: MCP Python SDK
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 The **MCP Python SDK** helps developers build applications (clients and servers) that talk to each other using the *Model Context Protocol (MCP)* specification.
 It simplifies communication by handling the low-level details like standard **message formats** (Abstraction 0), connection **sessions** (Abstraction 1), and different ways to send/receive data (**transports**, Abstraction 2).
 It also provides a high-level framework, **`FastMCP`** (Abstraction 3), making it easy to create servers that expose **tools** (Abstraction 5), **resources** (Abstraction 4), and **prompts** (Abstraction 6) to clients.
diff --git a/docs/NumPy Core/index.md b/docs/NumPy Core/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: NumPy Core
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 NumPy provides the powerful **ndarray** object, a *multi-dimensional grid* optimized for numerical computations on large datasets. It uses **dtypes** (data type objects) to precisely define the *kind of data* (like integers or floating-point numbers) stored within an array, ensuring memory efficiency and enabling optimized low-level operations. NumPy also features **ufuncs** (universal functions), which are functions like `add` or `sin` designed to operate *element-wise* on entire arrays very quickly, leveraging compiled code. Together, these components form the foundation for high-performance scientific computing in Python.
 
 
diff --git a/docs/OpenManus/index.md b/docs/OpenManus/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: OpenManus
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 OpenManus is a framework for building autonomous *AI agents*.
 Think of it like a digital assistant that can perform tasks. It uses a central **brain** (an `LLM` like GPT-4) to understand requests and decide what to do next.
 Agents can use various **tools** (like searching the web or writing code) to interact with the world or perform specific actions. Some complex tasks might involve a **flow** that coordinates multiple agents.
diff --git a/docs/Pydantic Core/index.md b/docs/Pydantic Core/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: Pydantic Core
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 Pydantic Core provides the fundamental machinery for **data validation**, **parsing**, and **serialization** in Pydantic. It takes Python *type hints* and uses them to define how data should be structured and processed. Users typically interact with it by defining classes that inherit from `BaseModel`, which automatically gets validation and serialization capabilities based on its annotated fields. Pydantic Core ensures data conforms to the defined types and allows converting between Python objects and formats like JSON efficiently, leveraging Rust for performance.
 
 
diff --git a/docs/Requests/index.md b/docs/Requests/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: Requests
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 Requests is a Python library that makes sending *HTTP requests* incredibly simple.
 Instead of dealing with complex details, you can use straightforward functions (like `requests.get()`) or **Session objects** to interact with web services.
 It automatically handles things like *cookies*, *redirects*, *authentication*, and connection pooling, returning easy-to-use **Response objects** with all the server's data.
diff --git a/docs/SmolaAgents/index.md b/docs/SmolaAgents/index.md
@@ -7,6 +7,8 @@ has_children: true
 
 # Tutorial: SmolaAgents
 
+> This tutorial is AI-generated! To learn more: https://github.com/The-Pocket/Tutorial-Codebase-Knowledge
+
 `SmolaAgents` is a project for building *autonomous agents* that can solve complex tasks.
 The core component is the **MultiStepAgent**, which acts like a project manager. It uses a **Model Interface** to talk to language models (LLMs), employs **Tools** (like web search or code execution) to interact with the world or perform actions, and keeps track of its progress and conversation history using **AgentMemory**.
 For agents that write and run Python code (`CodeAgent`), a **PythonExecutor** provides a safe environment. **PromptTemplates** help structure the instructions given to the LLM, while **AgentType** handles different data formats like images or audio. Finally, **AgentLogger & Monitor** provides logging and tracking for debugging and analysis.
diff --git a/docs/index.md b/docs/index.md
@@ -6,7 +6,7 @@ nav_order: 1
 
 # Turns Codebase into Easy Tutorial
 
-Ever stared at a new codebase written by others feeling completely lost? This project analyzes GitHub repositories and creates beginner-friendly tutorials explaining exactly how the code works.
+Ever stared at a new codebase written by others feeling completely lost? This project analyzes GitHub repositories and creates beginner-friendly tutorials explaining exactly how the code works - all powered by AI! Our intelligent system automatically breaks down complex codebases into digestible explanations that even beginners can understand.
 
 <p align="center">
   <a href="https://github.com/The-Pocket/PocketFlow" target="_blank">
@@ -16,7 +16,7 @@ Ever stared at a new codebase written by others feeling completely lost? This pr
   </a>
 </p>
 
-Built with [Pocket Flow](https://github.com/The-Pocket/PocketFlow), a 100-line LLM framework.
+This is a tutorial project of [Pocket Flow](https://github.com/The-Pocket/PocketFlow), a 100-line LLM framework. It crawls GitHub repositories and build a knowledge base from the code.
 
 ## Example Tutorials for Popular GitHub Repositories
 
