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

Exercise Solution Discussion #1025

Open
tuantinghuang opened this issue Oct 7, 2024 · 8 comments
Open

Exercise Solution Discussion #1025

tuantinghuang opened this issue Oct 7, 2024 · 8 comments
Assignees

Comments

@tuantinghuang
Copy link
Collaborator

tuantinghuang commented Oct 7, 2024

Summary of current exercise formats:

  1. Text + code with fill in blanksScreenshot 2024-10-07 at 16 57 55

  2. Text with a linked sketch as part of the promptScreenshot 2024-10-07 at 16 58 21

  3. Text only (Open question)Screenshot 2024-10-07 at 17 04 20


Mockup design for links to solution

If we are to compile an index page for exercise solutions, here's a proposed design of how we can link to the solution from the exercise, similar to how we have "copy/reveal answer." (Question: Does this link to the solution page, or directly to p5 sketch?)

Screenshot 2024-10-07 at 16 58 08

How to format the solution sketches in Notion?

Similarly to how we attach a sketch to an exercise, can we also place the sketch link as a bookmark in the exercise block , and add a label/callout (ex: web-only) so it renders as a link ("suggested answer") instead of showing the sketch? Also we can use the label to keep track of what we have only for the website, and not included in the printed version.

Something like this maybe?
Screenshot 2024-10-04 at 11 19 19

@shiffman
Copy link
Member

shiffman commented Oct 7, 2024

This works for me! I think the the "suggested solution" should link directly to a p5.js sketch.

@shiffman
Copy link
Member

shiffman commented Oct 8, 2024

Noting this is a continuation of the discussion in #55

@shiffman
Copy link
Member

shiffman commented Oct 8, 2024

So we're going to try the web only tag and implement this!

@shiffman
Copy link
Member

@tuantinghuang might as well as an explanation of how to submit an exercise solution on the README as well.

@shiffman
Copy link
Member

shiffman commented Nov 4, 2024

Noting the last piece here is to implemented the "suggested answer" label for when there is a "web only" exercise solution.

image

@shiffman
Copy link
Member

shiffman commented Nov 4, 2024

We're also going to add text based solutions with a "reveal answer" button, the proposed format in Notion is as follows:

Screenshot 2024-11-04 at 9 22 40 AM

(This is the solution from #1038)

@shiffman shiffman assigned jasongao97 and unassigned shiffman and tuantinghuang Nov 4, 2024
@shiffman
Copy link
Member

shiffman commented Nov 4, 2024

One more note is that the exercise p5 sketch embeds that are now marked with "web-only" should be hidden on the chapter pages and let's use another tag as with the text solutions above!

  • solution - text based exercise answer (label "reveal answer" reveals the answer)
  • p5-solution - p5 sketch (label "suggested answer" link to p5 web editor)

Ok, I think we are all set with this!

@jasongao97
Copy link
Contributor

Some update on this:

solution - text based exercise answer (label "reveal answer" reveals the answer)
p5-solution - p5 sketch (label "suggested answer" link to p5 web editor)

In the #1053 implementation, instead of using separate solution and p5-solution tags, I've opted for a unified solution tag where the type is inferred from the content. This approach should provide better consistency and simplified maintenance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants