Skip to content

feat: add comprehensive workshop improvements #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emmanuelandre wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: add comprehensive workshop improvements #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
165f590
feat: add comprehensive workshop improvements
Dec 4, 2025
e5aa69a
fix: resolve slide overflow and add tool-agnostic support
Dec 4, 2025
7311708
feat: add lecture and hands-on workshop presentations
Dec 4, 2025
b08065d
feat: add open-ended workshop presentation
Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 67 additions & 12 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,24 @@ claude-tutorial/
├── examples/
│ └── claude-md-template.md # Production-ready CLAUDE.md template
│
├── prompts.md # Workshop exercise prompts
├── prompts.md # Original workshop exercise prompts
├── workshop-prompts.md # Hands-on workshop prompts (auto-generated)
├── WORKSHOP_GUIDE.md # Instructor guide for workshops
├── claude-code-interactive-tutorial.pdf # Workshop slides
└── create_*.py # Python scripts to generate presentations
│
├── # Presentation PDFs
├── claude-code-interactive-tutorial.pdf # Original interactive workshop (2-3 hours)
├── ai-first-lecture.pdf # 1-hour lecture (no hands-on)
├── ai-first-workshop.pdf # 3-hour hands-on workshop (guided)
├── ai-first-openended-workshop.pdf # 3-hour open-ended workshop (choose your project)
├── openended-workshop-prompts.md # Prompts for open-ended workshop
│
├── # Python scripts to generate presentations
├── presentation_utils.py # Shared utilities for PDF generation
├── create_presentation.py # Generates overview PDF
├── create_interactive_presentation_v2.py # Generates interactive tutorial PDF
├── create_lecture_presentation.py # Generates 1-hour lecture PDF
├── create_handson_workshop.py # Generates 3-hour guided workshop PDF
└── create_openended_workshop.py # Generates 3-hour open-ended workshop PDF
```

## Key Concepts (Important for Editing)
Expand Down Expand Up @@ -122,10 +136,35 @@ The `examples/claude-md-template.md` is the **most important file** in this repo

### Workshop Materials

The workshop materials work together as a system:
- `claude-code-interactive-tutorial.pdf` - Main presentation slides
- `prompts.md` - Copy-paste prompts for hands-on exercises (references slide numbers)
- `WORKSHOP_GUIDE.md` - Instructor notes for running workshops
The workshop materials work together as a system. There are three presentation options:

**1. Original Interactive Workshop (2-3 hours)**
- `claude-code-interactive-tutorial.pdf` - Interactive tutorial with hands-on exercises
- `prompts.md` - Copy-paste prompts (references slide numbers)
- Best for: Standard workshop sessions

**2. Lecture Presentation (1 hour, no hands-on)**
- `ai-first-lecture.pdf` - Comprehensive lecture covering all topics
- No accompanying prompts file (lecture format)
- Best for: Conference talks, team briefings, executive overviews
- Topics: Philosophy, concerns, prompt engineering, testing, git, tips

**3. Guided Hands-On Workshop (3 hours)**
- `ai-first-workshop.pdf` - Guided workshop building auth feature
- `workshop-prompts.md` - Copy-paste prompts (auto-generated)
- Best for: Full training sessions with structured exercises
- Attendees follow step-by-step exercises

**4. Open-Ended Workshop (3 hours)**
- `ai-first-openended-workshop.pdf` - Choose your own project
- `openended-workshop-prompts.md` - Prompts for open-ended format
- Reference repo: `github.com/emmanuelandre/unveiling-claude`
- Best for: Experienced developers, hackathon-style sessions
- Attendees choose from sample specs or bring their own idea
- Minimal guidance after project selection - independent work with AI

**Instructor Guide:**
- `WORKSHOP_GUIDE.md` - Notes for running any workshop format

**Workshop GitHub Repository Convention:**
- All attendees create a private GitHub repository named: `unveiling-claude`
Expand All @@ -144,9 +183,22 @@ The workshop materials work together as a system:
### Python Presentation Scripts

The `create_*.py` files generate presentation PDFs:
- Not part of the tutorial content
- Used to regenerate PDFs when updating slides
- No need to maintain unless updating presentations

| Script | Output | Purpose |
|--------|--------|---------|
| `presentation_utils.py` | (shared module) | Common utilities for all presentations |
| `create_presentation.py` | `claude-code-tutorial.pdf` | Simple 17-slide overview |
| `create_interactive_presentation_v2.py` | `claude-code-interactive-tutorial.pdf` | Original interactive workshop |
| `create_lecture_presentation.py` | `ai-first-lecture.pdf` | 1-hour lecture (no hands-on) |
| `create_handson_workshop.py` | `ai-first-workshop.pdf` + `workshop-prompts.md` | 3-hour hands-on workshop |

**To regenerate presentations:**
```bash
.venv/bin/python3 create_lecture_presentation.py # Lecture
.venv/bin/python3 create_handson_workshop.py # Workshop
```

**Dependencies:** `reportlab` (installed in `.venv`)

## Common Tasks

Expand Down Expand Up @@ -224,7 +276,10 @@ fix: correct code example in git workflow
| `docs/06-testing-strategy.md` | E2E-first testing philosophy | Core methodology |
| `docs/07-ai-first-workflow.md` | 10-step development process | Core methodology |
| `docs/11-git-workflow.md` | Git conventions and best practices | Referenced by template |
| `prompts.md` | Workshop exercise prompts | Used with PDF workshop |
| `prompts.md` | Original workshop exercise prompts | Used with interactive tutorial PDF |
| `workshop-prompts.md` | Hands-on workshop prompts | Auto-generated, used with 3-hour workshop |
| `ai-first-lecture.pdf` | 1-hour lecture slides | No hands-on, conference/briefing format |
| `ai-first-workshop.pdf` | 3-hour workshop slides | Hands-on, build from scratch format |

## Important Notes

Expand Down Expand Up @@ -254,7 +309,7 @@ When making changes, preserve these core principles taught in this tutorial:

---

**Last Updated**: 2025-11-16
**Last Updated**: 2025-12-04
**Repository Type**: Educational Documentation
**Primary Audience**: Software developers learning AI-first development with Claude Code
- always update /docs, the pdf slides and the prompts.md
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ A comprehensive guide to working effectively with Claude Code (claude.ai/code) f

### Best Practices
- [Git Workflow](./docs/11-git-workflow.md) - Branch naming, commits, and PR management
- [Documentation Organization](./docs/12-documentation-organization.md) - Structure for plans, architecture, specs, and rules
- [Documentation Writing](./docs/13-documentation-writing.md) - API docs, code comments, and ADRs
- [Code Review](./docs/14-code-review.md) - Reviewing AI-generated code effectively
- [Security Practices](./docs/15-security.md) - Authentication, validation, and secrets management
- [Performance Optimization](./docs/16-performance.md) - Database, API, and frontend performance
- [CI/CD and Deployment](./docs/17-ci-cd.md) - GitHub Actions and deployment pipelines
- [Advanced Topics](./docs/18-advanced-topics.md) - MCP servers, multi-repo, and legacy code

### Reference
- [Troubleshooting](./docs/19-troubleshooting.md) - Common issues and solutions
Expand All @@ -30,6 +37,7 @@ A comprehensive guide to working effectively with Claude Code (claude.ai/code) f

### Examples
- [CLAUDE.md Template](./examples/claude-md-template.md) - Production-ready project configuration
- [my-api-project](./examples/my-api-project/) - Workshop reference example (Go API with PostgreSQL)

### Workshop Materials
- [Interactive Tutorial Slides](./claude-code-interactive-tutorial.pdf) - 40+ slide hands-on workshop
Expand Down
Loading