Skip to content

[Enhancement]: Evaluate Jupyter notebooks as supplementary examples #65

Description

@rosspeili

Area (optional)

examples

Problem or use case

Some users learn from interactive notebooks (explore session JSONL, step through approve flow, visualize audit report). Flat .py scripts (Examples flat restructure) are better for CI and copy-paste; notebooks may help onboarding and docs — unclear if worth maintenance cost.

Proposed behavior

RFC / spike — decide yes/no before implementation:

Option Pros Cons
examples/notebooks/*.ipynb Interactive narrative, charts on export Extra dev dep, CI complexity, drift from SDK
Notebooks in docs/ only Tied to docs sweep Not runnable as examples/
No notebooks Simpler repo Less hand-holding for evaluators

If yes: one notebook session_export_walkthrough.ipynb covering minimal loop + open .summary.json; optional [dev] extra jupyter; document in examples/README.md as supplementary (not replacing .py scripts).

If no: close with rationale in TESTING.md / CONTRIBUTING.

Alternatives considered (optional)

MyST or Quarto — heavier; defer.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussionDesign discussion or RFC.documentationDocs, README, or glossary updates.enhancementNew feature or improvement request.examplesCore patterns under examples/ and integration demos.rfcDesign RFC or discussion before implementation.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions