Examples in Docs

[AivanF]

Summary by CodeRabbit

• Documentation

  • Added a top-level "Examples" section with organized example pages and companion interactive notebooks
  • Enabled site search and a section-index for easier navigation
  • Updated example pages to point to their notebook variants and made small notebook output text tweaks

• Chores

  • Updated site build and lint tooling configurations and dependencies

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 39c10887-ad41-4504-babd-ea999292e982

📥 Commits

Reviewing files that changed from the base of the PR and between 3108074 and 5f9c986.

📒 Files selected for processing (3)

• .pre-commit-config.yaml
• pyproject.toml
• tests/integration/test_jaffle_shop_notebook.py

✅ Files skipped from review due to trivial changes (3)

• pyproject.toml
• .pre-commit-config.yaml
• tests/integration/test_jaffle_shop_notebook.py

---

📝 Walkthrough

Walkthrough

MkDocs configuration and site navigation updated; documentation plugin dependencies changed; multiple example pages updated to point to renamed companion notebooks; a few notebooks' output-print statements were simplified; pre-commit and Ruff lint settings adjusted; one integration test notebook path updated.

Changes

Cohort / File(s)	Summary
Documentation Dependencies docs/requirements.txt	Replaced mkdocs-material>=9.0 with mkdocs-jupyter>=0.24.0 and added mkdocs-section-index>=0.3.0.
MkDocs Configuration mkdocs.yml	Added top-level Examples navigation and configured plugins: search, section-index, and mkdocs-jupyter (include_source: true, ignore_h1_titles: true).
Example markdown pages (link targets updated) docs/examples/02_sql_vs_dsl/sql_vs_dsl.md, docs/examples/03_auto_ingest/auto_ingest.md, docs/examples/04_time/time.md, docs/examples/05_joined_measures/joined_measures.md, docs/examples/05_joins/joins.md, docs/examples/06_multistage_queries/multistage_queries.md	Updated companion notebook links to filenames suffixed with _nb.ipynb. One file still lacks a trailing newline.
Example notebooks (minor output edits) docs/examples/02_sql_vs_dsl/sql_vs_dsl_nb.ipynb, docs/examples/05_joins/joins_nb.ipynb	Replaced f-string print(f"...") with plain print("...") in output cells; printed messages unchanged.
Pre-commit hook .pre-commit-config.yaml	Bumped ruff-pre-commit hook rev from v0.8.6 to v0.15.6.
Ruff config pyproject.toml	Added [tool.ruff.lint.per-file-ignores] entry to ignore E402 for tests/**.
Integration test tests/integration/test_jaffle_shop_notebook.py	Updated NOTEBOOK_PATH to point to docs/examples/03_auto_ingest/auto_ingest_nb.ipynb (path built with os.path.join).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 New notebooks hop into our docs so bright,
Links retuned, plugins set just right,
Search and jupyter help them play,
Examples bundled for a brighter day,
Hooray for docs that learn and light! 📚

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Examples in Docs' is vague and generic, not clearly describing what was actually changed in the PR.	Consider a more descriptive title such as 'Rename notebook files and integrate mkdocs-jupyter' or 'Add examples section to docs with notebook integration' that better captures the main changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch aivan/2026-04-09-Examples-in-Docs

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}