Dictionary Video-to-Vocabulary: Getting Started Checklist

⚡ Quick Start (Copilot Method - 15 minutes)

Prerequisites

• Have a YouTube video URL you want to learn from
• Have GitHub Copilot Chat or ChatGPT access

Steps

• Install youtube-transcript-api: pip install youtube-transcript-api
• Get video transcript: youtube-transcript-api VIDEO_ID --format text > transcript.txt
• Read /docs/dictionary/02-workflows/copilot-integration/
• Copy the main prompt template
• Replace [TOPIC] with your topic
• Replace [TRANSCRIPT] with your transcript
• Paste into Copilot Chat
• Wait for YAML output
• Copy output to data/dictionary/[topic]/vocabulary.yaml
• Validate YAML: python -c "import yaml; yaml.safe_load(open('data/dictionary/[topic]/vocabulary.yaml'))"
• Create Hugo page: hugo new content/docs/dictionary/[topic]/index.md --kind dictionary
• Edit Hugo page to reference your topic
• Test: npm run dev:memory
• Visit: http://localhost:1313/docs/dictionary/[topic]/
• Review and edit Urdu translations
• Commit: git add data/dictionary/ content/docs/dictionary/ && git commit -m "Add vocabulary from [video]"

Estimated Time: 15-20 minutes

🐍 Python Script Setup (One-time - 10 minutes)

Prerequisites

• Python 3.8 or higher installed
• OpenAI API account

Setup Steps

• Navigate to scripts: cd scripts/dictionary
• Create virtual environment: python3 -m venv .venv
• Activate: source .venv/bin/activate (Linux/Mac) or .venv\Scripts\activate (Windows)
• Install dependencies: pip install -r requirements.txt
• Copy env template: cp .env.example .env
• Get OpenAI API key from: https://platform.openai.com/api-keys
• Edit .env and add your API key: OPENAI_API_KEY=sk-...
• Test installation: python extract_vocabulary.py --help

Estimated Time: 10 minutes

🚀 Using Python Script (5 minutes per video)

Each Video

• Copy video URL

• Run script:

  1python scripts/dictionary/extract_vocabulary.py \
  2  --video-url "https://youtube.com/watch?v=VIDEO_ID" \
  3  --topic "my-topic" \
  4  --create-hugo-page \
  5  --source-name "Video Title"
  

• Wait for processing (30-60 seconds)

• Review generated files:

  • data/dictionary/my-topic/vocabulary.yaml
  • content/docs/dictionary/my-topic/index.md

• Edit Urdu translations as needed

• Test: npm run dev:memory

• Visit: http://localhost:1313/docs/dictionary/my-topic/

• Commit when satisfied

Estimated Time: 5-10 minutes per video

📚 Documentation Checklist

Before Starting

• Read: /docs/dictionary/04-reference/implementation-notes/
• Read: /docs/dictionary/00-overview/

When Using Copilot

• Reference: /docs/dictionary/02-workflows/copilot-integration/
• Follow: /docs/dictionary/03-guides/video-to-vocab/ - Method 1

When Using Python Script

• Reference: scripts/dictionary/README.md in your project
• Follow: /docs/dictionary/03-guides/video-to-vocab/ - Method 2

For Understanding System

• Review: /docs/dictionary/04-reference/workflow-analysis/
• Review: /docs/dictionary/04-reference/complete-guide/

🎯 Success Metrics

After processing your first video, check:

• YAML file has 20-25 vocabulary entries
• Each entry has all required fields (word, part_of_speech, urdu_meaning, example_en, example_ur)
• Urdu text displays correctly in browser
• Accordion expands/collapses properly
• Words are appropriate difficulty for your level
• Translations are natural and contextual
• You learned something useful!

🐛 Troubleshooting Checklist

If Transcript Fetch Fails

• Check if video has captions enabled
• Try different video
• Use manual transcript extraction

If YAML is Invalid

• Check syntax at yamllint.com
• Look for missing quotes around Urdu text
• Check indentation (must be consistent)

If Urdu Doesn’t Display

• Check font is loaded (static/fonts/Jameel-Noori-Nastaleeq.ttf)
• Verify shortcode CSS includes @font-face
• Test in different browser

If Words Are Too Easy/Hard

• Adjust --difficulty-threshold parameter
• Customize Copilot prompt criteria
• Manually review and remove/add words

If API Call Fails

• Check API key is correct in .env
• Verify you have OpenAI credits
• Check internet connection
• Review error message

📊 Progress Tracker

Track your vocabulary building:

Week 1

• Process 3 videos
• Total words: ___
• Topics covered: ___

Week 2

• Process 5 videos
• Total words: ___
• Topics covered: ___

Month 1

• Process 15+ videos
• Total words: ___
• Topics covered: ___
• Review and practice regularly
• Export to Anki (optional)

🎓 Learning Goals

Set your goals:

• Target: ___ words per week
• Focus topics: ___
• Difficulty level: ___
• Review schedule: ___

💬 Feedback Loop

After trying the system:

• What worked well?
• What needs improvement?
• Prompt modifications needed?
• Script enhancements desired?
• Documentation clarity?

🚦 Current Status

• Documentation complete
• Python script ready
• Copilot prompts ready
• Tested with real video (YOUR TURN!)
• Validated translations
• Workflow refined for your needs

Next Action: Pick one video and follow this checklist!

Time Investment: 15-20 minutes Expected Outcome: 20-25 vocabulary entries with Urdu translations

Start now! 🚀