processing / processing/p5.js

[p5.js 2.0 Bug Report]: Add docs about the 2.0 reference-generation process

Open
#8,508 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

p5.js 2.0+
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

Description

Most appropriate sub-area of p5.js?
  • Build process
p5.js version

v2.x

I think there's a use for documentation around the build process for the 2.0 reference (and type-declarations).

Splitting this new issue out from #8454 to deal only with the build process.

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 how the p5.js 2.0 reference and type declarations are generated, focusing on the build process described by this issue. Document the relevant process and its relationship to the reference and type declarations; done means a newcomer can understand how to generate them.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.