agentleFS
levi-qiaolevi-qiao/obsidian-llm-wiki/.claude/skills/tutor-setup/SKILL.md

tutor-setup

Skill9 starsChanged 7 months agoMITView on GitHub

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.

  • Installs packages

4 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

11 rules. About 0 are common, 6 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Tie-break: If .git/ is the sole indicator and no source code files (*.ts, *.py, *.java, *.go, *.rs, etc.) exist, default to Document Mode.

    line 29
  2. Very specific:

    If pdftotext is not installed, install it first: brew install poppler (macOS) or apt-get install poppler-utils (Linux).

    line 47
  3. Distinctive:

    Read cover page + TOC + 3+ sample pages from middle/end for EVERY source file

    line 52
  4. Distinctive:

    Classification completeness: When source enumerates categories ("3 types of X"), every member gets a dedicated note.

    line 68
  5. Distinctive:

    Registry: Only registered tags allowed.

    line 76
  6. Very specific:

    Create StudyVault/ with numbered folders per templates.md.

    line 80
  7. Very specific:

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

    line 84
  8. Very specific:

    Quick Reference: every heading includes → [[Concept Note]] link.

    line 87
  9. Distinctive:

    Every topic folder MUST have a practice file (8+ questions)

    line 103
  10. Distinctive:

    Verify against quality-checklist.md Document Mode section.

    line 119
  11. Distinctive:

    Tags/keywords: ALWAYS English

    line 150

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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 found → Codebase Mode
  3. If no marker found → Document 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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.