CB Learn
Overview
Analyze one open-source project from a GitHub URL and produce three structured study artifacts:
- •
architecture.md - •
design-tradeoffs.md - •
learning-notes.md
Default input is URL-only. If the user additionally provides analysis lens or analysis depth, expand detail accordingly.
Workflow
- •Validate scope and input.
- •Require a GitHub repository URL.
- •If missing, ask for URL first.
- •Gather evidence from repository.
- •Read top-level docs (
README,docs/, contribution/architecture notes). - •Map main directories and entry points.
- •Identify key runtime or build boundaries.
- •Build architecture model.
- •Infer core components and responsibilities.
- •Explain key data/control flows.
- •Distinguish stable interfaces from volatile internals.
- •Extract design trade-offs.
- •Capture major design choices.
- •For each choice: selected option, alternatives, rationale, costs, and risks.
- •Mark inferences explicitly when source evidence is indirect.
- •Produce learning notes.
- •Summarize reusable principles.
- •Add anti-patterns or pitfalls observed.
- •Add transfer checklist for applying insights in other projects.
- •Output exactly three files in the response.
- •Use templates in
references/output-templates.md.
Detail Expansion Rules
Apply these rules in order.
- •URL only (default)
- •Use standard depth with general architecture perspective.
- •Prioritize clarity over breadth.
- •Analysis lens provided
- •Keep the base report, then deepen sections relevant to the lens.
- •Example lenses: performance, reliability, extensibility, testability, operability.
- •Analysis depth provided
- •
quick: high-level structure and top decisions only. - •
standard: module interactions, evidence-backed trade-offs. - •
deep: stronger evidence, alternative designs, refactor opportunities, validation strategy.
- •Lens + depth both provided
- •Combine both expansions: lens-focused and depth-specific detail.
Output Contract
Always return three titled sections that correspond to these files:
- •
architecture.md - •
design-tradeoffs.md - •
learning-notes.md
Use concise evidence-linked statements. Prefer “source says X, so inference is Y” over unsupported claims.
Quality Checks
Before finalizing:
- •Ensure every major claim has a source pointer or explicit inference label.
- •Ensure trade-offs include both benefit and cost.
- •Ensure learning notes are actionable outside the analyzed project.