processing / processing/p5.js-website
"Getting Started with Instance Mode" Tutorial
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 96
- Forks
- 322
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 8
Description
Topic
p5.js supports both "instance mode" and "global mode." This sketch shows the difference:
https://editor.p5js.org/p5/sketches/Instance_Mode:_Instantiating
Please share your confusions!
If you've had a confusing experience with instance mode in the past, please share how that was even if you don't want to work on the tutorial!
The task: translate existing materials to be more beginner-friendly
Here is the p5.js wiki entry explaining these ideas: https://github.com/processing/p5.js/wiki/Global-and-instance-mode
If you've found these resources a little daunting in the past, please feel free to set up a more approachable tutorial to be featured on the p5js.org website. This means creating a getting-started-with-instance-mode.mdx in main/src/content/tutorials/en.
Although there is an upcoming release of p5.js 2.0, the first version of this tutorial can focus on 1.x; but it might need to be updated for the 2.0 version of the website.
(This task is inspired by the discussion in https://github.com/processing/p5.js/issues/7332 and https://github.com/processing/p5.js/issues/7670, so feel free to check those out too.)
How to create a tutorial
Here's an example tutorial about a different topic: https://github.com/processing/p5.js-website/blob/main/src/content/tutorials/en/getting-started-with-nodejs.mdx?plain=1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the p5.js wiki entry on Global and instance mode, the linked Instance Mode sketch, and src/content/tutorials/en/getting-started-with-nodejs.mdx. Create getting-started-with-instance-mode.mdx with a more approachable explanation and examples for p5.js 1.x; done means the tutorial is suitable for beginners and accounts for the possible website update for 2.0.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100