// Add an interactive exercise with solution to an existing lesson. Creates properly formatted exercise and solution admonition blocks. Use when a lesson needs hands-on practice.
| name | add-exercise |
| description | Add an interactive exercise with solution to an existing lesson. Creates properly formatted exercise and solution admonition blocks. Use when a lesson needs hands-on practice. |
Add an exercise with solution to an existing training lesson.
See ../shared/repo-conventions.md for directory structure and file conventions.
Follow these steps:
Ask the user:
Read the lesson file to understand context
Create the exercise using the ??? exercise admonition:
??? exercise "Exercise: [Title]"
Brief description of what to do.
1. First step
2. Second step
3. Expected outcome
!!! tip
Helpful hint if needed
Create the corresponding solution using ??? solution or ??? result:
??? solution "Solution"
Explanation of the solution approach.
```groovy title="filename.nf" linenums="1"
[solution code]
```
Expected output:
```console title="Output"
[expected output]
```
If the exercise requires a solution file:
[module]/solutions/Insert the exercise at an appropriate point in the lesson:
Test the exercise:
Remind the user to:
Run comprehensive validation and review checks including heading numbering, TODO/FIXME comments, Nextflow script conventions, orphaned files, admonition syntax, lesson structure, formatting, content accuracy, and teaching effectiveness. Use when validating, reviewing, or checking training materials quality, lesson quality, or before committing changes.
Walk through a training tutorial as a user would, progressively building examples exactly as instructed, running all commands, and verifying results against solutions. Use when testing tutorials end-to-end or validating that instructions are correct and complete.
Verify that hl_lines attributes in markdown code blocks correctly highlight the intended lines. Use when reviewing documentation with code examples, especially Before/After comparisons, or when highlights seem incorrect.
Review inline code in markdown files for proper formatting and syntax highlighting. Check for missing backticks on CLI flags, filenames, and code elements. Verify that inline syntax highlighting (#!groovy) is used appropriately. Use when reviewing documentation or quiz questions.
Set up a Docker container for running Nextflow training examples. Handles basic setup, Docker-outside-of-Docker (DooD) for containerized processes, ARM Mac platform emulation, and troubleshooting. Use when you need to run Nextflow examples in a consistent environment.
Search markdown files, Nextflow scripts, and config files for TODO/FIXME comments, categorize by priority, and provide actionable recommendations. Use when you need to identify pending work or track technical debt.