Skip to content

Add workshop docs, repo hygiene, and notebook CI - #9

Open
Divergent-Code wants to merge 1 commit into
camunity:mainfrom
Divergent-Code:docs/workshop-setup
Open

Add workshop docs, repo hygiene, and notebook CI#9
Divergent-Code wants to merge 1 commit into
camunity:mainfrom
Divergent-Code:docs/workshop-setup

Conversation

@Divergent-Code

Copy link
Copy Markdown

This repo shipped as two notebooks + a LICENSE with no onboarding. This PR adds the scaffolding a workshop repo that people fork actually needs. It touches no notebook files, so it's independent of #6 (the correctness/robustness fixes) and can be reviewed on its own.

What's added

  • README.md — what the project is, the V1 → V2 progression, "Open in Colab" badges for each notebook, the GOOGLE_API_KEY prerequisite + Colab Secrets setup, local-run instructions, and a short PII note.
  • .gitignore — Jupyter checkpoints, Python caches, virtualenvs, local Chroma persistence, and editor/OS cruft (so students don't accidentally commit them).
  • requirements.txt — the notebooks' dependencies for local (non-Colab) runs, with minimum-version pins and a note that Colab preinstalls several.
  • .github/workflows/validate-notebooks.yml — CI that validates each notebook's JSON structure and compiles every code cell on push/PR. It is structure/syntax only — it does not execute the notebooks (that would need a Gemini key + heavy ML deps). This mirrors the manual checks used in Fix RAG eval, guardrail ordering, and agent indexing in v2 notebook #6 and stops a broken notebook from ever landing.

Notes

🤖 Generated with Claude Code

The repo shipped as bare notebooks + LICENSE with no onboarding. Add the
project scaffolding a forkable workshop needs:

- README.md — what the project is, the V1 -> V2 progression, Colab "Open in
  Colab" badges, the GOOGLE_API_KEY prerequisite and Colab Secrets setup,
  local-run instructions, and a PII note.
- .gitignore — Jupyter checkpoints, Python caches, virtualenvs, local Chroma
  persistence, and editor/OS cruft.
- requirements.txt — pinned-minimum deps for local (non-Colab) runs.
- .github/workflows/validate-notebooks.yml — validates notebook JSON and
  compiles every code cell on push/PR (structure/syntax only; does not run
  the notebooks). Mirrors the manual checks used while fixing the notebooks.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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