Tutorials

Learning-oriented lessons for getting started with NHL Scrabble.

These tutorials walk you through practical tasks step-by-step, helping you build familiarity with the package.

Tutorial Lessons

• Getting Started with NHL Scrabble
  • What you’ll learn
  • Prerequisites
  • Installation Options
  • Step 1: Clone the repository
  • Step 2: Set up the development environment
  • Step 3: Run your first analysis
  • Step 4: Understanding the output
  • Step 5: Save output to a file
  • Step 6: Try JSON output
  • Step 7: Customize the output
  • What you’ve learned
  • Next steps
  • Troubleshooting
  • Getting help
• Understanding NHL Scrabble Output
  • What you’ll learn
  • Prerequisites
  • Step 1: Generate a full report
  • Step 2: Conference standings
  • Step 3: Division standings
  • Step 4: Mock playoff bracket
  • Step 5: Team detail reports
  • Step 6: League-wide player rankings
  • Step 7: Statistical summary
  • Step 8: Working with JSON output
  • What you’ve learned
  • Next steps
  • Fun challenges
  • Common questions
  • Getting help
• Your First Contribution to NHL Scrabble
  • What you’ll learn
  • Prerequisites
  • Step 1: Fork the repository
  • Step 2: Clone your fork
  • Step 3: Set up development environment
  • Step 4: Run the test suite
  • Step 5: Create a feature branch
  • Step 6: Make a small change
  • Step 7: Write a test
  • Step 8: Run tests
  • Step 9: Run quality checks
  • Step 10: Commit your changes
  • Step 11: Push to your fork
  • Step 12: Create a pull request
  • Step 13: Wait for CI checks
  • Step 14: Address review feedback
  • Step 15: Celebrate! 🎉
  • What you’ve learned
  • Next steps
  • Tips for success
  • Common issues
  • Getting help

What You’ll Learn

Tutorial 1: Getting Started

Install NHL Scrabble and run your first analysis. Understand the basic workflow and see the package in action.

Tutorial 2: Understanding Output

Deep dive into the analysis output. Learn how to interpret team standings, playoff brackets, and statistics reports.

Tutorial 3: First Contribution

Make your first code contribution. Set up the development environment, run tests, and submit a pull request.

Next Steps

After completing these tutorials, you’ll be ready to:

• How-To Guides - Solve specific problems with how-to guides

• Reference - Look up CLI options and configuration

• Explanation - Understand the design and architecture

• Development Guide - Contribute to the project

About the Tutorial Format

These tutorials follow the Diátaxis framework for technical documentation:

• Learning-oriented - Focused on teaching, not just showing

• Step-by-step - Clear progression from start to finish

• Safe to explore - Can’t break anything by following along

• Practical - Build real understanding through doing

Tips for Success

• Work through tutorials in order (1 → 2 → 3)

• Type commands yourself rather than copy-pasting

• Experiment with variations once you complete each section

• Don’t skip the explanations - understanding “why” helps retention