tutor-skills  by RoundTable02

AI-powered system for knowledge vaulting and active recall

Created 2 weeks ago

New!

472 stars

Top 64.7% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides two Claude Code skills, tutor-setup and tutor, designed to transform various knowledge sources into interactive learning materials within Obsidian. It addresses the need for efficient knowledge consolidation and active recall by automatically generating structured study vaults from documents (PDFs, Markdown, HTML, EPUB) and source code projects, followed by an interactive quiz system that tracks user comprehension at a granular concept level. The primary benefit is closing the learning loop from raw content to demonstrated understanding, aiding developers, researchers, and students in mastering complex information.

How It Works

The tutor-setup skill processes input documents or codebases, automatically detecting the mode. In Document Mode, it extracts and analyzes content from files, generating interlinked notes, concept summaries, practice questions with hidden answers, and a dashboard including a Map of Content (MOC). In Codebase Mode, it analyzes project structure, tech stack, architecture patterns, and data/request flows to create an onboarding vault with module-specific notes, architecture overviews, and developer exercises. The tutor skill then leverages these generated "StudyVaults" for interactive quizzes, presenting questions based on user proficiency and tracking mastery at a concept level using distinct emoji badges.

Quick Start & Requirements

  • Primary install: npx skills add RoundTable02/tutor-skills
  • Prerequisites: Claude Code CLI installed and configured; Obsidian is recommended for vault navigation.
  • Manual install: git clone https://github.com/RoundTable02/tutor-skills.git followed by ./install.sh.
  • Links: Repository README serves as primary documentation.

Highlighted Details

  • Dual processing modes: Document Mode for general files and Codebase Mode for source code projects.
  • Automated Obsidian StudyVault generation with structured notes, dashboards (MOC, Quick Reference, Exam Traps/Getting Started), and active recall questions.
  • Codebase Mode offers architecture analysis, flow tracing, and developer onboarding exercises.
  • Concept-level quiz tracking with proficiency badges (🟥 Weak, 🟨 Fair, 🟩 Good, 🟦 Mastered, ⬜ Unmeasured) and detailed progress monitoring.

Maintenance & Community

No specific details regarding maintainers, community channels (like Discord/Slack), or roadmap were provided in the README.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: The MIT license is permissive and generally allows for commercial use and integration into closed-source projects without significant restrictions.

Limitations & Caveats

The tool is dependent on the Claude Code CLI for its core functionality. While Obsidian is recommended for optimal use, it is not strictly required for vault generation. The effectiveness of the generated vaults and quizzes relies heavily on the accuracy of the Claude Code CLI's analysis of the input documents and codebases. Processing time for large inputs may be considerable.

Health Check
Last Commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
2
Star History
475 stars in the last 19 days

Explore Similar Projects

Feedback? Help us improve.