Add workshop docs, repo hygiene, and notebook CI - #9
Open
Divergent-Code wants to merge 1 commit into
Open
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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, theGOOGLE_API_KEYprerequisite + 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
camunity/main, so they resolve correctly once merged here.🤖 Generated with Claude Code