Skip to content

Jupyter Notebook Example & Getting-Started Guide #10

@github-actions

Description

@github-actions

Description

Add a Jupyter notebook (examples/basic_rag.ipynb) that walks through the full pipeline step-by-step with prose explanations, and a docs/getting-started.md guide.

Motivation

A notebook lowers the barrier to entry for data scientists and ML practitioners who prefer interactive environments over scripts. Good documentation is what turns visitors into contributors.

Acceptance criteria

  • examples/basic_rag.ipynb — notebook that runs end-to-end using built-in components (no API key needed)
  • Each notebook section has a markdown cell explaining what the code does and why
  • Notebook covers: install → load → chunk → embed → ingest → query → inspect results
  • All cells execute without errors (jupyter nbconvert --to notebook --execute examples/basic_rag.ipynb)
  • docs/getting-started.md with: installation options, quickstart code, explanation of each ABC, link to CONTRIBUTING.md
  • CHANGELOG.md updated under [Unreleased]

Files to touch

  • examples/basic_rag.ipynb — new notebook
  • docs/getting-started.md — new doc page
  • examples/README.md — add notebook to the table

Resources

  • examples/basic_rag.py — the script version to convert to a notebook
  • nbformat docs if creating the notebook programmatically

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions