codebase-to-course

Solid

Load when a user wants a source-backed interactive HTML course that explains how a codebase works; do not load for chat tutoring, repository review, articles, slide decks, or general browser artifacts.

AI & Automation 84 stars 0 forks Updated 5 days ago

Install

View on GitHub

Quality Score: 78/100

Stars 20%
64
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
0
Description 5%
100

Skill Content

# Codebase to Course Turn a real codebase into a factual, interactive HTML course for a reader who needs to understand and change the system, not memorize terminology. ## Routing This Skill owns a course artifact whose subject is a codebase. - Use `quick-learn` for multi-session teaching, assessment, and durable learner progress. - Use `code-review` for findings about correctness or maintainability. - Use `source-post` for a public article. - Use `frontend-slides` for a presentation. - Use `web-artifacts-builder` only when accepted course interactions genuinely need an application framework rather than a self-contained document. Do not combine those outputs by default. A course is a learning artifact, not a review report with quizzes attached. ## Evidence Contract Inspect before explaining: 1. Read the repository contract, README, entry points, configuration, tests, and the smallest set of implementation files needed to trace one representative user or operator journey. 2. Identify the system's real actors, ownership boundaries, data movement, external dependencies, and one meaningful failure or debugging path. 3. Separate observed facts from inference. Every implementation claim in the course must point to a current repository-relative file and line or symbol anchor. 4. Use only short, exact source snippets. Do not simplify source code and present the result as verbatim code. 5. Exclude credentials, secrets, customer data, generated vendor trees, and unrelated propri...

Details

Author
JasonxzWen
Repository
JasonxzWen/harness-hub
Created
4 months ago
Last Updated
5 days ago
Language
JavaScript
License
None

Similar Skills

Semantically similar based on skill content — not just same category