docs(AGENTS.md): document HTML renderer, full type table, and pedagogy patterns - #89
Merged
Merged
Conversation
…nd pedagogy patterns Four gaps surfaced during a biology worksheet generation session: 1. HTML rendering path was entirely undocumented — `worksheet_html_renderer.py` and `build_print_packet_html()` are now explained in §1 with a decision table for when to prefer HTML vs PIL. 2. `feature_matrix` data format split documented — HTML renderer expects `items` as plain strings; PIL factory expects dicts with `name`/`checked_properties`. Mixing these produces silent broken output. 3. Worksheet type table expanded from 7 to all 20 types, with HTML/PIL support flags and camelCase kind strings for each HTML-renderable type. 4. New §4 Pedagogical Best Practices captures patterns that were taught interactively and should be defaults going forward: "Let's Discuss" oral discussion questions (response_lines: 0), word bank shuffling, outdoor activity integration in the instructions field, and the consistent character-hook pattern. Co-Authored-By: Claude Sonnet 4.6 <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
1 participant
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.
Summary
worksheet_html_renderer.pyandbuild_print_packet_html()added to §1 with a decision table (HTML preferred for printable packets; PIL for image-heavy types)feature_matrixdata format split — HTML renderer expectsitemsas plain strings; PIL factory expects dicts withname/checked_properties. Not documenting this causes silent broken output with no errorresponse_lines: 0), word bank shuffling, outdoor activity integration in theinstructionsfield, and the consistent character-hook patternTest plan
src/worksheet_html_renderer.py_RENDERERSdict andsrc/worksheets/factory.py🤖 Generated with Claude Code