Skip to content

Add example notebooks and notebook docs#25

Merged
nicosuave merged 2 commits intomainfrom
readme-notebooks
Mar 27, 2026
Merged

Add example notebooks and notebook docs#25
nicosuave merged 2 commits intomainfrom
readme-notebooks

Conversation

@nicosuave
Copy link
Copy Markdown
Member

@nicosuave nicosuave commented Mar 27, 2026

  • add the adtech kitchen sink and Looker-style demo notebooks
  • document how to run the notebooks with juv
  • note the local extension path the notebooks use when available
  • note the fallback to installing yardstick from community

The DuckDB 1.5.x compatibility work remains in #24.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f36f5ead59

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +105 to +106
uvx juv run docs/yardstick_adtech_kitchen_sink.ipynb
uvx juv run docs/yardstick_looker_demo.ipynb
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point notebook commands to existing files

The new notebook workflow commands reference docs/yardstick_adtech_kitchen_sink.ipynb and docs/yardstick_looker_demo.ipynb, but this repository (including commit 9c6c40b) contains no .ipynb files, so users following these instructions will immediately hit a file-not-found error. Please either add the notebooks or update the commands to paths that exist in-tree.

Useful? React with 👍 / 👎.

@nicosuave nicosuave changed the title Document notebook workflow Add example notebooks and notebook docs Mar 27, 2026
@chatgpt-codex-connector
Copy link
Copy Markdown

💡 Codex Review

https://github.com/sidequery/yardstick/blob/5cfa369d8177cd73234b53042db1c566a06ca620/docs/yardstick_adtech_kitchen_sink.ipynb#L4972
P1 Badge Remove trailing literal from notebook JSON

This notebook is not valid JSON because the final line contains a literal \n after the closing brace (}\n), so tools that parse .ipynb (e.g., juv run/Jupyter) fail with Extra data and the example cannot be opened or executed. The second notebook parses correctly, so this is isolated to this file and should be fixed before users rely on the documented command.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@nicosuave nicosuave merged commit 6591df9 into main Mar 27, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant