Improve #13
Improve #13
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes notebook metadata and documentation across the workshop materials to ensure consistent Python 3.11.14 environment configuration and clarify installation instructions.
Key changes:
- Updated all notebooks to specify Python 3.11.14 in kernel metadata
- Added VS Code interpreter configuration for automatic kernel selection
- Clarified that dependencies are installed per-notebook rather than via
make setup
Reviewed Changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| temporal_installation.ipynb | Added kernel selection instructions and updated metadata to Python 3.11.14 |
| solutions/03_durable_agent/solution_durability.ipynb | Standardized metadata and fixed cell ID |
| solutions/03_durable_agent/solution.ipynb | Standardized metadata and fixed cell ID |
| solutions/02_temporal_hello_world/solution.ipynb | Updated kernel metadata to Python 3.11.14 |
| solutions/01_agent_hello_world/solution.ipynb | Updated metadata and included execution outputs |
| scripts/apply_notebook_metadata.py | Added VS Code metadata configuration for auto-kernel selection |
| exercises/03_durable_agent/exercise.ipynb | Reformatted markdown cells and updated metadata |
| exercises/02_temporal_hello_world/exercise.ipynb | Updated kernel metadata to Python 3.11.14 |
| exercises/01_agent_hello_world/exercise.ipynb | Clarified dependency installation approach |
| example-notebook/03-Human-in-the-Loop-Solution.ipynb | Updated kernel metadata to Python 3.11.14 |
| example-notebook/02-Adding-Durability-Solution.ipynb | Updated kernel metadata to Python 3.11.14 |
| README.md | Removed make setup references and clarified per-notebook installation |
| CLAUDE.md | Removed make setup references and improved formatting |
| .github/copilot-instructions.md | Removed make setup from essential commands |
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "execution_count": 2, |
There was a problem hiding this comment.
The solution notebook includes execution outputs and execution counts, which should typically be cleared before committing to version control. This prevents merge conflicts and keeps the repository clean. Consider adding a pre-commit hook or using jupyter nbconvert --clear-output to strip outputs.
| " OPENAI_API_KEY=sk-your-key-here\n", | ||
| " ```\n", | ||
| "\n", | ||
| "3. **Dependencies:** Installed in the first cell of this notebook:\n", |
There was a problem hiding this comment.
The documentation states dependencies are 'Installed in the first cell of this notebook', but according to the workshop guidelines, setup should be done via make setup. This creates inconsistency with the overall workshop flow where make setup is the standard installation method mentioned in README.md.
| "3. **Dependencies:** Installed in the first cell of this notebook:\n", | |
| "3. **Dependencies:** Installed via `make setup`:\n", |
| " ```\n", | ||
| "\n", | ||
| "2. **Dependencies:** Already installed if you ran `make setup`\n", | ||
| "2. **Dependencies:** Installed in the first cell of this notebook:\n", |
There was a problem hiding this comment.
The documentation states dependencies are 'Installed in the first cell of this notebook', but this conflicts with the project's established pattern where make setup is the primary installation method. While per-notebook installation provides self-containment, the documentation should clarify the relationship between these two approaches.
No description provided.