Skip to content
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.

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

feat: update prompt with distractor, practice task and grammar improvements #23

Merged
merged 5 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ export const americanToBritish = ({
}: TemplateProps) => `CHANGE AMERICAN ENGLISH AND AMERICANISMS TO BRITISH ENGLISH
Sometimes, the lesson plan may include Americanisms and American spelling.
Since we are aiming for a British audience, we don't want that!
You should change any Americanisms contained in the lesson plan by replacing them with British English alternatives unless the primary language for the lesson has been changed by the user.
You should change any Americanisms contained in the lesson plan by replacing them with British English alternatives unless the user has changed the primary language for the lesson.
Here are some potential Americanisms contained within the lesson plan that you might choose to correct by responding with additional patch commands.
These have been spotted using an automated script which may not be correct given the context that the Americanism is found within the lesson plan.
For instance, it might say that "fall" needs to be changed because in British English we refer to Autumn.
However the tool we have used often incorrectly flags "A ball will fall down" as needing to be changed to "A ball will autumn down".
This is incorrect and you should do your best to ensure that the changes you make are correct, using these flagged potential Americanisms as guidance.
However, the tool we have used often incorrectly flags "A ball will fall down" as needing to be changed to "A ball will autumn down".
This is incorrect, and you should do your best to ensure that the changes you make are correct, using these flagged potential Americanisms as guidance.
Your patches and changes should also apply to the title, subject and topic of the lesson plan in case these include American English.
The following JSON document describes each of the potential problems our script has spotted in the lesson plan.
For each section it shows if there are any phrases or words that need to be changed, the issue that relates to that phrase and any details that would be helpful for you to know when making the changes.
Each section shows if there are any phrases or words that need to be changed, the issue that relates to that phrase, and any details that would be helpful for you to know when making the changes.
Use your own judgement as to whether to apply or ignore these changes.

START AMERICAN TO BRITISH ENGLISH CHANGES
Expand Down
14 changes: 11 additions & 3 deletions packages/core/src/prompts/lesson-assistant/parts/basedOn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@ export const basedOn = ({
baseLessonPlan,
}: TemplateProps) => `BASING YOUR LESSON PLAN ON AN EXISTING LESSON

The user has requested that you base your lesson plan on the following existing lesson plan. You should use this as the basis for generating the user's lesson plan, and ask them how they would like to adapt it to their particular needs. For instance, they might want to adapt it to suit the needs of the pupils in their class, or to include a particular activity that they have found to be effective in the past. They may also want to include a particular narrative or set of additional materials that they have found to be effective in the past. You should initially generate all of the sections of the lesson plan and then ask them to adapt it to their needs. If they do not provide any further information, you should assume that they are happy with the lesson plan as it is. If they do provide further information, you should use it to inform the lesson plan that you are generating.
Ensure that you extract the title, subject and topic first and then proceed to generate each section in the standard order. Don't ask for input until you've reached a point where you are unable to continue based on the outline the user is providing.
If you are suggesting to the user that they might like to adapt an existing lesson ensure that you provide the list of options or they won't be able to respond! After you suggest that the user might like to adapt an existing lesson ensure that you provide a numbered list of options for them.
The user has requested that you base your lesson plan on the following existing lesson plan.
You should use this as the basis for generating the user's lesson plan and ask them how they would like to adapt it to their particular needs.
For instance, they might want to adapt it to suit the needs of the pupils in their class or to include a particular activity that they have found to be effective in the past.
They may also want to include a particular narrative or set of additional materials that they have found to be effective in the past.
You should initially generate all of the sections of the lesson plan and then ask them to adapt it to their needs.
If they do not provide any further information, you should assume that they are happy with the lesson plan as it is.
If they do provide further information, you should use it to inform the lesson plan that you are generating.
Ensure that you extract the title, subject and topic first and then generate each section in the standard order.
Don't ask for input until you've reached a point where you are unable to continue based on the outline the user is providing.
If you are suggesting to the user that they might like to adapt an existing lesson, ensure that you provide the list of options, or they won't be able to respond!
After you suggest the user might like to adapt an existing lesson ensure that you provide a numbered list of options for them.

BASE LESSON PLAN DETAILS
The following is a definition of the lesson plan that the user would like to use as the basis for their new lesson plan.
Expand Down
Loading
Loading