PluginBench
Skill
Review
Audit score 70

tutor-setup

roundtable02/tutor-skills

Transform PDFs, code, or web sources into an interactive Obsidian StudyVault with practice questions and architecture guides.

What is tutor-setup?

Tutor Setup auto-detects whether you're learning from documents (PDFs, text, web) or onboarding to a codebase, then generates a structured Obsidian vault with concept notes, practice questions, and interlinking. Use it to convert any knowledge source into a self-study system with active recall and spaced repetition support.

  • Auto-detect Document Mode (PDFs/text/web → study notes) or Codebase Mode (source code → developer onboarding vault)
  • Extract and map knowledge sources with verified topic hierarchies and source-to-note traceability
  • Generate concept notes with YAML frontmatter, wiki-links, callouts, and ASCII diagrams
  • Create practice question sets with active recall fold callouts and question-type diversity (recall, application, analysis)
  • Build interactive dashboards with MOCs, Quick References, Exam Traps, and tag indices
  • Produce module-focused onboarding vaults for codebases with architecture analysis and exercises

How to install tutor-setup

npx skills add https://github.com/roundtable02/tutor-skills --skill tutor-setup
Prerequisites
  • Obsidian installed (to view the generated StudyVault)
  • For PDF extraction: pdftotext CLI (install via `brew install poppler` on macOS or `apt-get install poppler-utils` on Linux)
  • Source files (PDFs, code, text, or URLs) accessible or copied into the current working directory
Claude Code
Cursor
Windsurf
Cline

How to use tutor-setup

  1. 1.Run `npx skills add https://github.com/roundtable02/tutor-skills --skill tutor-setup` to install
  2. 2.Navigate to a directory containing your knowledge sources (PDFs, code project, text files, or URLs)
  3. 3.Invoke the skill with `tutor-setup [source-path-or-url]` (or omit argument to scan CWD)
  4. 4.Confirm the auto-detected mode (Document or Codebase) or override if needed
  5. 5.Review and verify the source mapping and topic checklist presented by the skill
  6. 6.Wait for vault generation to complete; open `StudyVault/` in Obsidian to study

Use cases

Good for
  • Convert a textbook or research paper PDFs into a study vault with practice questions for exam prep
  • Generate a new-developer onboarding guide from an existing codebase with architecture notes and code-reading exercises
  • Transform web articles and documentation into structured concept notes with cross-linking for self-paced learning
  • Create a comprehensive study system from multiple knowledge sources with unified tagging and weak-area tracking
  • Build architecture documentation and module guides for team onboarding from source code analysis
Who it's for
  • Students preparing for exams or comprehensive learning
  • New developers joining a codebase who need structured onboarding
  • Educators converting course materials into interactive study systems
  • Knowledge workers organizing and studying technical documentation
  • Teams documenting architecture and module relationships for knowledge transfer

tutor-setup FAQ

What file formats does Document Mode support?

PDF, plain text (.txt), Markdown (.md), HTML (.html), and EPUB. PDFs are converted to text via pdftotext CLI before processing to avoid token waste.

Can I use it on a codebase with mixed languages?

Yes. Codebase Mode detects the tech stack automatically (Node.js, Python, Java, Go, Rust, C#, Ruby, etc.). Generated notes match the source material language; tags are always English.

What if files are outside my current working directory?

The skill enforces a CWD boundary for security. Copy external files into your working directory first, then run the skill.

How does the skill handle multi-file sources?

It performs mandatory source-to-note mapping: reads cover, TOC, and sample pages from each file to verify actual content and page ranges, then builds a verified mapping before creating notes.

Can I override the auto-detected mode?

Yes. The skill announces the detected mode and asks for confirmation; you can override it if needed.

Full instructions (SKILL.md)

Source of truth, from roundtable02/tutor-skills.


name: tutor-setup description: > Transforms knowledge sources into an Obsidian StudyVault. Two modes: (1) Document Mode — PDF/text/web sources → study notes with practice questions. (2) Codebase Mode — source code project → onboarding vault for new developers. Mode is auto-detected based on project markers in CWD. argument-hint: "[source-path-or-url]" allowed-tools: Read, Write, Edit, Glob, Grep, Bash, WebFetch

Tutor Setup — Knowledge to Obsidian StudyVault

CWD Boundary Rule (ALL MODES)

NEVER access files outside the current working directory (CWD). All source scanning, reading, and vault output MUST stay within CWD and its subdirectories. If the user provides an external path, ask them to copy the files into CWD first.

Mode Detection

On invocation, detect mode automatically:

  1. Check for project markers in CWD:
    • package.json, pom.xml, build.gradle, Cargo.toml, go.mod, Makefile, *.sln, pyproject.toml, setup.py, Gemfile
  2. If any marker foundCodebase Mode
  3. If no marker foundDocument Mode
  4. Tie-break: If .git/ is the sole indicator and no source code files (*.ts, *.py, *.java, *.go, *.rs, etc.) exist, default to Document Mode.
  5. Announce detected mode and ask user to confirm or override.

Document Mode

Transforms knowledge sources (PDF, text, web, epub) into study notes. Templates: templates.md

Phase D1: Source Discovery & Extraction

  1. Auto-scan CWD for **/*.pdf, **/*.txt, **/*.md, **/*.html, **/*.epub (exclude node_modules/, .git/, dist/, build/, StudyVault/). Present for user confirmation.
  2. Extract text (MANDATORY tools):
    • PDF → pdftotext CLI ONLY (run via Bash tool). NEVER use the Read tool directly on PDF files — it renders pages as images and wastes 10-50x more tokens. Convert to .txt first, then Read the .txt file.
      pdftotext "source.pdf" "/tmp/source.txt"
      
    • If pdftotext is not installed, install it first: brew install poppler (macOS) or apt-get install poppler-utils (Linux).
    • URL → WebFetch
    • Other formats (.md, .txt, .html) → Read directly.
  3. Read extracted .txt files — understand scope, structure, depth. Work exclusively from the converted text, never from the raw PDF.
  4. Source Content Mapping (MANDATORY for multi-file sources):
    • Read cover page + TOC + 3+ sample pages from middle/end for EVERY source file
    • NEVER assume content from filename — file numbering often ≠ chapter numbering
    • Build verified mapping: { source_file → actual_topics → page_ranges }
    • Flag non-academic files and missing sources
    • Present mapping to user for verification before proceeding

Phase D2: Content Analysis

  1. Identify topic hierarchy — sections, chapters, domain divisions.
  2. Separate concept content vs practice questions.
  3. Map dependencies between topics.
  4. Identify key patterns — comparisons, decision trees, formulas.
  5. Full topic checklist (MANDATORY) — every topic/subtopic listed. Drives all subsequent phases.

Equal Depth Rule: Even a briefly mentioned subtopic MUST get a full dedicated note supplemented with textbook-level knowledge.

  1. Classification completeness: When source enumerates categories ("3 types of X"), every member gets a dedicated note. Scan for: "types of", "N가지", "categories", "there are N".
  2. Source-to-note cross-verification (MANDATORY): Record which source file(s) and page range(s) cover each topic. Flag untraceable topics as "source not available".

Phase D3: Tag Standard

Define tag vocabulary before creating notes:

  • Format: English, lowercase, kebab-case (e.g., #data-hazard)
  • Hierarchy: top-level → domain → detail → technique → note-type
  • Registry: Only registered tags allowed. Detail tags co-attach parent domain tag.

Phase D4: Vault Structure

Create StudyVault/ with numbered folders per templates.md. Group 3-5 related concepts per file.

Phase D5: Dashboard Creation

Create 00-Dashboard/: MOC, Quick Reference, Exam Traps. See templates.md.

  • MOC: Topic Map + Practice Notes + Study Tools + Tag Index (with rules) + Weak Areas (with links) + Non-core Topic Policy
  • Quick Reference: every heading includes → [[Concept Note]] link; all key formulas
  • Exam Traps: per-topic trap points in fold callouts, linked to concept notes

Phase D6: Concept Notes

Per templates.md. Key rules:

  • YAML frontmatter: source_pdf, part, keywords (MANDATORY)
  • source_pdf MUST match verified Phase D1 mapping — never guess from filename
  • If unavailable: source_pdf: 원문 미보유
  • [[wiki-links]], callouts ([!tip], [!important], [!warning]), comparison tables > prose
  • ASCII diagrams for processes/flows/sequences
  • Simplification-with-exceptions: general statements must note edge cases

Phase D7: Practice Questions

Per templates.md. Key rules:

  • Every topic folder MUST have a practice file (8+ questions)
  • Active recall: answers use > [!answer]- 정답 보기 fold callout
  • Patterns use > [!hint]- / > [!summary]- fold callouts
  • Question type diversity: ≥60% recall, ≥20% application, ≥2 analysis per file
  • ## Related Concepts with [[wiki-links]]

Phase D8: Interlinking

  1. ## Related Notes on every concept note
  2. MOC links to every concept + practice note
  3. Cross-link concept ↔ practice; siblings reference each other
  4. Quick Reference sections → [[Concept Note]] links
  5. Weak Areas → relevant note + Exam Traps; Exam Traps → concept notes

Phase D9: Self-Review (MANDATORY)

Verify against quality-checklist.md Document Mode section. Fix and re-verify until all checks pass.


Codebase Mode

Generates a new-developer onboarding StudyVault from a source code project. Full workflow: codebase-workflow.md Templates: codebase-templates.md

Phase Summary

PhaseNameKey Action
C1Project ExplorationScan files, detect tech stack, read entry points, map directory layout
C2Architecture AnalysisIdentify patterns, trace request flow, map module boundaries and data flow
C3Tag StandardDefine #arch-*, #module-*, #pattern-*, #api-* tag registry
C4Vault StructureCreate StudyVault/ with Dashboard, Architecture, per-module, DevOps, Exercises folders
C5DashboardMOC (Module Map + API Surface + Getting Started + Onboarding Path) + Quick Reference
C6Module NotesPer-module notes: Purpose, Key Files, Public Interface, Internal Flow, Dependencies
C7Onboarding ExercisesCode reading, configuration, debugging, extension exercises (5+ per major module)
C8InterlinkingCross-link modules, architecture ↔ implementations, exercises ↔ modules
C9Self-ReviewVerify against quality-checklist.md Codebase Mode section

See codebase-workflow.md for detailed per-phase instructions.


Language

  • Match source material language (Korean → Korean notes, etc.)
  • Tags/keywords: ALWAYS English