noc-book-2 icon indicating copy to clipboard operation
noc-book-2 copied to clipboard

p5.js examples workflow

Open shiffman opened this issue 2 years ago • 4 comments

Note for @jasongao97 and I to finalize the p5.js example workflow. Ideally I would just work on / change examples in the p5 web editor and that would propagate to a GitHub repo and the embeds on the site. TBD.

shiffman avatar Sep 21 '22 14:09 shiffman

Related to this I'll want to adjust this language in the introduction. The p5 web editor examples are primary but for print readers it may be useful to have a page that links to all examples.

Each time you see the above Example heading in this book, it means there is a corresponding code example available on GitHub.

shiffman avatar Sep 21 '22 15:09 shiffman

I'm noticing that the p5 web editor examples do not include the code-split notation—which is fine, they shouldn't but I'll likely need to do a pass over the book to cross-check all the embedded code with the examples (if I'm making minor adjustments to the web editor versions.)

shiffman avatar Sep 21 '22 15:09 shiffman

Screen Shot 2022-09-28 at 9 54 09 AM

I'm switching example URLs from ID to slug alias. So if we accidentally delete or replace the source sketch, we just need to keep them the same name and don't need to update the URL in the content.

jasongao97 avatar Sep 28 '22 13:09 jasongao97

Notes from our meeting. All code for the book can be categorized as:

  • Example (tied to a specific example # in the book)
  • Exercise (tied to a specific exercise # in the book)
  • Figure (tied to a sepcific figure # in the book)
  • Extra (community contribution or extra example provided by me)

We just need a naming convention for the slugs. To be continued. . .

shiffman avatar Sep 28 '22 14:09 shiffman

I think this can be closed. @jasongao97 anything here left to consider?

shiffman avatar Feb 11 '23 20:02 shiffman

Well, we certainly have the examples working now, closing!

shiffman avatar Sep 10 '23 00:09 shiffman