User Guide
This section has been reorganized following the Diátaxis framework. Please use the new structure:
Learning-oriented lessons - Start here if you’re new
Problem-oriented guides - Solve specific tasks
Understanding-oriented - Learn design rationale
Technical specifications - Look up details
Quick Links
For complete usage documentation, see:
Getting Started with NHL Scrabble - Installation and first analysis
Understanding NHL Scrabble Output - Interpret results
How to Configure API Settings - Customize API behavior
How to Export to JSON - Export data programmatically
CLI Reference - Complete CLI reference
Environment Variables Reference - All configuration options
About the Documentation Structure
This documentation follows the Diátaxis framework, which organizes content by purpose rather than topic:
- Tutorials (Learning)
Step-by-step lessons that teach you how to use NHL Scrabble. Start here if you’re completely new.
- How-To Guides (Problem-Solving)
Practical recipes for accomplishing specific tasks. Use these when you have a specific goal.
- Explanation (Understanding)
Background context and design rationale. Read these to understand why things work the way they do.
- Reference (Information)
Complete technical specifications. Look things up here when you need exact details.
Why This Structure?
Traditional documentation often mixes tutorials, guides, explanations, and reference material, making it hard to find what you need. The Diátaxis framework separates these concerns, so you can quickly navigate to the right type of information for your current need.
Learn more: https://diataxis.fr/