skills.rest
zhengfran
zhengfranCOMMUNITY
Explore all skills by this author →
GitHub

tutor-setup

Convert knowledge sources or codebases into structured Obsidian StudyVaults.

Updated Jul 11, 2022
Search Tags:#obsidian#active recall#codebase onboarding#tag taxonomy#studyvault#knowledge transformation#pdf-to-text
One-click install
npx skills add https://github.com/zhengfran/dotconfig --skill tutor-setup-zhengfran
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tutor-setup
Source: https://github.com/zhengfran/dotconfig/tree/main/tools/ai/agents/skills/tutor-setup
Command: npx skills add https://github.com/zhengfran/dotconfig --skill tutor-setup-zhengfran

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

tutor-setup transforms messy learning inputs (PDFs/text/web pages or a source code project) into a structured Obsidian StudyVault with concept notes, practice questions, dashboards, and consistent tagging.

Core Features & Use Cases

  • Automatic mode detection: Chooses Document Mode or Codebase Mode based on project markers in your current working directory (CWD).
  • Document Mode: Scans CWD sources, extracts text from PDFs via pdftotext, builds a verified source-to-topic mapping, and generates topic-complete concept notes plus practice questions.
  • Codebase Mode: Explores the codebase, identifies architecture and modules, creates a developer onboarding vault (dashboard, architecture, module notes, exercises), and self-validates against a quality checklist.
  • Safety guardrails: Enforces a strict CWD boundary—never reads or writes outside the current working directory.

Quick Start

Run tutor-setup with your source path or URL, for example: tutor-setup --argument-hint "[source-path-or-url]".

Frequently Asked Questions about tutor-setup

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

FAQPage Schema
How do I turn a codebase into an Obsidian vault for developer onboarding?▼

To turn a codebase into an Obsidian vault, tutor-setup detects project markers in your current working directory and generates architecture notes, module dashboards, and onboarding exercises with standardized tags.

How do I extract text from PDFs and generate Obsidian study notes?▼

To extract text from PDFs and generate Obsidian study notes, the tool uses pdftotext to scan sources, builds a verified source-to-topic mapping, and outputs topic-complete concept notes and practice questions.

How does automatic mode detection work when creating an Obsidian StudyVault?▼

Automatic mode detection works by scanning your current working directory for project markers, switching between Document Mode for text extraction and Codebase Mode for generating developer onboarding vaults.

Can I use tutor-setup to process files outside my current working directory?▼

No, you cannot process files outside your current working directory because the tool enforces a strict CWD boundary as a safety guardrail, ensuring it never reads or writes external data.

What is the best way to organize learning inputs into a structured tag taxonomy in Obsidian?▼

The best way to organize learning inputs into a structured tag taxonomy is by transforming messy sources into concept notes and dashboards with consistent tagging standards applied automatically during vault generation.

Does tutor-setup require any external dependencies to extract PDF text?▼

Yes, extracting PDF text requires the pdftotext utility, which the tool uses to convert PDF documents into text files for building the verified source-to-topic mapping and subsequent concept notes.

Related Skills

Explore More Education & Research Skills→
NeKon69NeKon69
1

user.project_root

Resolve the project root directory by searching upward for marker files.

Community
Basic
drunkcodingdrunkcoding
4

cuda-tutor-setup

Generate an Obsidian-format CUDA StudyVault with a 6-topic curriculum.

Community
Advanced
purvishrivastava27purvishrivastava27

flashcard-generator

Convert notes into spaced repetition flashcards and AI-generated quizzes.

Community
Intermediate
HerxinsasaHerxinsasa
1

obsidian-vault

Automate Obsidian vault note search, creation, and wikilink management.

Community
Intermediate