teach-goal

Generates exhaustive five-level teaching documentation for open-source repositories via an autonomous Goal Loop.

2|Updated Jul 6, 2026
One-click install
npx skills add https://github.com/NAMEWTA/learning-open-code --skill teach-goal-namewta
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: teach-goal
Source: https://github.com/NAMEWTA/learning-open-code/tree/main/.agents/skills/teach-goal
Command: npx skills add https://github.com/NAMEWTA/learning-open-code --skill teach-goal-namewta

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Understanding a large open-source codebase end-to-end is slow and unstructured; this Skill autonomously produces complete teaching documentation covering every source file, from high-level architecture down to individual functions and edge cases. ## Core Features & Use Cases - Goal Loop Orchestration: Autonomously builds a goal backlog (L0 overview, L1 modules, L2 vertical slices, L3 API references, L4 deep dives), dispatches up to 4 parallel subagents, audits outputs, and loops until full source coverage is verified. - Five-Level Teaching System: Produces HTML short lessons and reference documents organized into 00-overview/, module-, slice-, and deep-dive-* topic directories under teach/<project>/. - Quality Gates: Enforces path validation, topic audits via audit_topic.py, sampled teach-review subagent reviews, and a Definition of Done checklist with coverage diff scanning. - Use Case: Point it at a repository like RuoYiVuePlus and ask for a complete walkthrough; it generates a Wiki-style 00-index.md navigation plus dozens of short lessons tracing features like login authentication from route to database. ## Quick Start Ask the agent to generate complete teaching documentation for a specific project directory or repository in the workspace, covering everything from architecture to implementation details.

Frequently Asked Questions about teach-goal

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate complete teaching documentation for an open-source project?▼

Provide the target repository path and request a full walkthrough. The skill scans the repo, creates an L0 overview, builds a goal backlog of modules and features, then autonomously dispatches subagents to produce HTML lessons and reference docs until coverage checks pass.

What is a vertical slice in code documentation?▼

A vertical slice traces one user-perceivable feature from its entry point through every layer to its destination, such as route to middleware to service to database. Each slice must cover the entry point, every layer, a call sequence diagram, at least one error path, and cross-links.

Where does the generated teaching output get written?▼

All output is written to teach/<path>/ at the workspace root, where <path> comes from the .gitmodules logical project path. Writing to .agents/ or any non-teach/ path is strictly forbidden and validated before goals can be marked done.

How does the Goal Loop ensure full source code coverage?▼

After the goal queue empties, it diffs all repository source files against files referenced in generated docs. Missing files spawn supplementary L3 goals, and the loop repeats until the diff is empty and the Definition of Done checklist passes.

What happens when a generated lesson fails review?▼

Goals with Critical review issues are marked needs_fix and sent back to a teach subagent for repair, with at most two fix-review cycles. Goals still failing after that, or after three execution retries, are marked blocked and listed in the final report for human intervention.

Can the skill skip trivial or boilerplate code files?▼

No file may be completely skipped; the rules only allow reducing detail level. Third-party vendor code, auto-generated files, binaries, and test fixtures can be exempted, but each exemption must be listed with a justification in the L0 phase.