Playbook
Role-Based Onboarding Hub
Coaching-staff hub for choosing the right nbadb route by role, task, and first command.
Role-Based Onboarding Hub
Welcome to the coaching staff room for nbadb. Use this page to pick your role, run the opening drill, and get onto the right page before you burn time wandering the whole playbook.
Route board in one glance
| Role today | Start here | First useful action | Leave with |
|---|---|---|---|
| Contributor | Installation | Run uv sync --extra dev so the local toolchain is real before you touch code or docs | A working dev environment and the right follow-up page |
| Analyst without local setup | SQL Playground | Run one sample query in the browser and change a filter, aggregate, or sort | A query shape you can port to live data |
| Analyst with live data | Analytics Quickstart | Connect to nba.duckdb and stop once SHOW TABLES confirms the floor | One working answer or reusable notebook cell |
| Operator | Daily Updates | Run nbadb status --output-format json so you know the current state before you choose daily, monthly, or backfill run | A clean run, a deliberate rerun, or an isolated failure lane |
| Stakeholder | Architecture | Run nbadb schema for the fastest public-model snapshot | A clear picture of what the dataset contains and how it moves |
Quick route board
Contributor
First read: Installation.
First useful action: uv sync --extra dev.
Next stop: CLI Reference.
Analyst
First read: SQL Playground for browser-only reps, or Analytics Quickstart for live data.
First useful action: run the Playground leaderboard example, or
nbadb download if you are moving straight to the full dataset.
Next stop: Analytics Quickstart.
Operator
First read: Daily Updates.
First useful action: nbadb status --output-format json, then
nbadb daily when the recurring lane is clear.
Next stop: Troubleshooting Playbook .
Stakeholder
First read: Architecture.
First useful action: nbadb schema.
Next stop: Schema Reference.
Browser warm-up
First read: SQL Playground.
First useful action: run one sample query and change one filter, sort, or
aggregate.
Next stop: Analytics Quickstart.
Pick one lane, run one useful action, then branch. If you are not sure where to begin, choose the row that matches the job you need done today, not the title on your org chart. If you need the lowest-friction start possible, take the browser lane first and move to the local warehouse second.
Pick your lane
Each tab gives you the same scan path:
- Run first to get moving
- Open next so you land on the right follow-up page
- Watch for so the common misses do not cost a second possession
Primary route: Installation → CLI Reference → Architecture
Run first
$ uv sync --extra dev- Keep the current command surface nearby in CLI Reference.
- Read Architecture before changing pipeline flow, table families, or generated docs.
Open next
Regenerate docs
Run uv run nbadb docs-autogen --docs-root docs/content/docs after schema changes so generator-owned docs stay in sync.
Watch for
Primary route: SQL Playground → Analytics Quickstart → DuckDB Query Examples
Run first
$ nbadb download- If you want a no-install warm-up first, open SQL Playground and run the leaderboard example before you download anything.
- Or use an existing
nba.duckdbor Parquet export. - Start with
analytics_*surfaces for the fastest first query. - Move into the table-level docs only after you know the question you want to answer.
Open next
SQL Playground
Use SQL Playground when you want one browser-only rehearsal before connecting to the real dataset.
Watch for
Primary route: Daily Updates → CLI Reference → Troubleshooting Playbook
Run first
$ nbadb status --output-format json- If the state looks clean and you are on the recurring cadence, run
nbadb dailynext. - Review what each run mode actually does:
daily,monthly,backfill run,status,scan. - Confirm your data directory and output expectations.
- Keep the latest health artifacts in view:
-
artifacts/health/daily/dependency-inventory.json -
artifacts/health/daily/data-quality-report.json -
artifacts/endpoint-coverage/*
-
Open next
Troubleshooting Playbook
Use Troubleshooting Playbook the moment a run leaves you with a failing artifact, a broken command, or a recovery question.
Architecture
Use Architecture to review validation tiers, internal state, and run-mode boundaries.
Watch for
Primary route: Architecture → Schema Reference → ER Diagram
Run first
$ nbadb schema- Read Architecture for the source-to-export story.
- Scan Schema Reference to understand what the public dataset actually contains.
- Review Kaggle Setup when the conversation shifts to distribution and delivery.
Open next
Watch for
Keep moving
Stay in the same possession
Keep the mental model warm with adjacent pages, section hubs, and search-friendly routes into the same topic cluster.
Analytics Quickstart
Land quick wins fast and move from setup to analysis with intent.
SQL Playground
Rehearse DuckDB syntax and query structure in the browser before touching the full warehouse.
DuckDB Query Examples
Move from the browser sandbox into real warehouse query patterns and analyst-ready examples.
