202603242045-template-project-card

🎯 Core Idea

Use this section to explain what the software project is, what problem it solves, why it is worth studying, and what makes its implementation interesting. Write this as a coherent explanation, not as scattered notes. When referring to files, modules, commands, config keys, classes, functions, or special tokens, wrap them in backticks.

🌲 Branching Questions

Use this section to sort out the implementation logic of the project through a small number of high-value questions. Prefer questions such as:

➡ What is the best mental model for this project?

Explain the project at the system level: what it does, how it is structured, and how to think about its moving parts.

➡ Which files should I read first, and why?

Identify the highest-value source files or modules and explain what each one reveals about the project.

➡ What is the main execution flow?

Trace the most important runtime path through the codebase step by step. Focus on real code paths instead of README summaries.

➡ What are the key abstractions or design choices?

Explain the major abstractions, interfaces, conventions, or architectural decisions that shape how the system works.

➡ What reading path gives the fastest understanding?

Give a concrete order for manually reading the repo so the important files come first and the lower-value files come later.

You may replace these default questions when the project demands better ones, but keep the total number of questions small and high-signal.

📚 References