Adding prompt field and clarifying it from the description field - #27
Adding prompt field and clarifying it from the description field#27durkinza wants to merge 2 commits into
Conversation
|
Addresses #18 |
There was a problem hiding this comment.
Pull request overview
This PR introduces a new prompt field to separate player-facing challenge introductions from coordinator-facing descriptions. The description field is now optional and serves as internal documentation for event coordinators, while the prompt field contains the text shown to players.
Key Changes
- Added a new
promptfield to the challenge schema for player-facing text - Made the
descriptionfield optional and repurposed it for coordinator documentation - Updated two example challenges to demonstrate the separation of concerns
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/challenge-schema/index.ts |
Added new prompt field definition and updated description field to be optional with clarified purpose for coordinators |
tests/examples/cookie-monster/challenge.json |
Split original description into a brief prompt and detailed coordinator description |
tests/examples/caesar-cipher/challenge.json |
Split original description into a player prompt and technical explanation for coordinators |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
The /docs still need updated to reflect the changes from this PR. |
|
I believe this PR may need to be closed or repurposed. The description field of the challenge.json was originally mean to be the prompt for the player and not a description for the event coordinator. However, this is likely confusing and perhaps the description field should be renamed to clarify. The description field is not part of a challenge and adds bulk to the challenge.json. Likewise it wouldn't be much help for event coordinators that have a bundled challenge since the challenge schema contain the solutions steps already and that would likely be the only part of the challenge.json important to event coordinators. |
No description provided.