processing / processing/p5.js

[p5.strands] Document `shared*` methods

Open Beginner friendly
#8,440 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area:WebGL Enhancement
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

Description

Increasing access

These are used in other examples to pass data between hooks, but they do not yet have their own reference pages.

Most appropriate sub-area of p5.js?
  • Accessibility
  • Color
  • Core/Environment/Rendering
  • Data
  • DOM
  • Events
  • Image
  • IO
  • Math
  • Typography
  • Utilities
  • WebGL
  • Build process
  • Unit testing
  • Internationalization
  • Friendly errors
  • Other (specify if possible)
Feature enhancement details

These should live in a new p5.strands section of the reference and contain parameters and usage examples.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the examples that use the shared* methods and the existing p5.strands reference structure. Add a new p5.strands reference section covering each method's parameters and usage examples, then confirm the pages explain how the methods pass data between hooks.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
computer-graphics, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.