Conversation
…rkshops with AI agents. Co-authored-by: me <me@kentcdodds.com>
|
Cursor Agent can help with this pull request. Just |
Co-authored-by: me <me@kentcdodds.com>
kentcdodds
left a comment
kentcdodds
left a comment
There was a problem hiding this comment.
@cursoragent, there seems to be a bit of duplication between the emoji guide and the agent workflow. I think we can reduce that duplication (favor the agent workflow).
Also, I would prefer to chunk up the agent workflow into individual markdown files to not overload the agent with too many irrelevant things. Maybe we could make a directory of these.
In general I would like this structured such that the agent can progressively add more context as needed where each markdown file references the relevant markdown files as it progresses through the tasks.
Also, please check the comments I've left on this PR as well.
instructor/09-emoji-guide.md
Outdated
| ```mdx | ||
| # Exercise Title | ||
|
|
||
| <EpicVideo url="..." /> |
There was a problem hiding this comment.
When making a new workshop, you often don't have videos to include. Probably remove this line to not confuse the agent.
instructor/09-emoji-guide.md
Outdated
| ```mdx | ||
| # Step Title | ||
|
|
||
| <EpicVideo url="..." /> |
There was a problem hiding this comment.
Remove this reference to not confuse the agent.
instructor/09-emoji-guide.md
Outdated
| ```mdx | ||
| # Exercise Title | ||
|
|
||
| <EpicVideo url="..." /> |
There was a problem hiding this comment.
Remove this reference to not confuse the agent.
instructor/09-emoji-guide.md
Outdated
| [Transition to next step if applicable] | ||
| ``` | ||
|
|
||
| ### Summary Pattern |
There was a problem hiding this comment.
Maybe these sections should include what file they appear in. So this would be:
### Summary Pattern (FINISHED.mdx)
instructor/09-emoji-guide.md
Outdated
| // 🚨 If this test is failing, make sure you've exported the function | ||
| // as a named export, not a default export. | ||
| expect(myFunction).toBeDefined() |
There was a problem hiding this comment.
Instead this should be:
expect(myFunction, `🚨 make sure you've exported the function as a named export, not a default export`).toBeDefined()
|
Done! Here's a summary of the changes: Changes Made1. Created
|
…ntent guides Co-authored-by: me <me@kentcdodds.com>
…rkflow Co-authored-by: me <me@kentcdodds.com>
Co-authored-by: me <me@kentcdodds.com>
…tices Co-authored-by: me <me@kentcdodds.com>
Add patterns to ignore files with '.ignored' extension
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| ```mdx | ||
| # Exercise Title | ||
|
|
||
| <EpicVideo url="https://..." /> |
There was a problem hiding this comment.
EpicVideo in templates contradicts guidance to omit it
Medium Severity · BugBot Rules
The PR reviewer explicitly flagged this: "When making a new workshop, you often don't have videos to include. Probably remove this line to not confuse the agent." The README structure templates include <EpicVideo url="https://..." /> components, but instructor/05-mdx-and-content.md explicitly states not to include these when first creating workshops. This inconsistency could cause AI agents to incorrectly add video embeds to new workshops.
Additional Locations (2)
| myFunction, | ||
| `🚨 Make sure you exported the function as a named export, not default` | ||
| ).toBeDefined() | ||
| ``` |
There was a problem hiding this comment.
Test assertion message format differs from reviewer suggestion
Low Severity · BugBot Rules
The PR reviewer explicitly stated the test assertion format should be: expect(myFunction, '🚨 make sure you've exported the function as a named export, not a default export').toBeDefined(). The current format uses different wording ("Make sure you exported" vs "make sure you've exported", "not default" vs "not a default export") and multi-line formatting instead of the suggested single-line format.
Additional Locations (1)
| Let's see how to test this hook next. | ||
| ``` | ||
|
|
||
| ### Exercise Summary (FINISHED.mdx) |
There was a problem hiding this comment.
Exercise Summary sections missing full file path
Low Severity · BugBot Rules
The PR reviewer commented "Maybe these sections should include what file they appear in." The Exercise Summary section headers in instructor/05-mdx-and-content.md and instructor/09-emoji-guide.md show ### Exercise Summary (FINISHED.mdx) without the full path, while instructor/04-writing-exercises.md correctly shows ### Exercise Summary (exercises/XX.exercise-name/FINISHED.mdx). This path inconsistency could confuse AI agents about where the file should be created.
Additional Locations (1)
2 participants
Add comprehensive instructor documentation for AI-driven Epic Workshop creation.
This documentation enables AI agents to systematically build workshops following Epic Workshop best practices and format, covering all aspects from planning and scoping to implementation, content creation, and validation.
Note
Introduces complete documentation for building Epic Workshops with AI agents and links it from
README.md.instructor/with step-by-stepworkflow/(discovery → planning → setup → implementation → content → validation → verification)README.mdwith instructions on using the new docs.gitignorewith generic ignored patternsWritten by Cursor Bugbot for commit a5f0968. This will update automatically on new commits. Configure here.