Skip to content

Add list of 2.x changes to the p5.js-compatibility README #14

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

Open
davepagurek opened this issue Apr 5, 2025 · 3 comments
Open

Add list of 2.x changes to the p5.js-compatibility README #14

davepagurek opened this issue Apr 5, 2025 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@davepagurek
Copy link
Collaborator

We have some lists in the descriptions of #1 and #2. At some point (this can be post-2.0 launch if need be) it would be good to collect all of these changes in one visible spot in the readme.

@davepagurek davepagurek added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Apr 5, 2025
@ksen0
Copy link
Member

ksen0 commented Apr 29, 2025

It might be also useful to check the 2.0.0 release notes.

@ksen0 ksen0 moved this to Ready for Work in p5.js 2.x 🌱🌳 Apr 29, 2025
@ksen0 ksen0 moved this from Ready for Work to Open for Discussion in p5.js 2.x 🌱🌳 Apr 29, 2025
@ksen0 ksen0 added this to the 2.1 milestone Apr 29, 2025
@ksen0
Copy link
Member

ksen0 commented Apr 29, 2025

The scope of this task is to update the README of this repo to have a single visible list of all changes, with clear indication which changes have which compatibility add-on, and which transition steps are needed. This should preferably address both authors of sketches, and authors of add-on libraries (see also: this add-on library system in 2.0 and transitioning from 1.x guide).

Keeping this as "open for discussion" because that's quite an ambitious scope for a one-page README, so ideas are welcome on how to best present this information!

This would be a good first issue for a new contributor already familiar with p5.js 1.x and wanting to really get more in-depth understandigng of 2.x

@ksen0 ksen0 changed the title Add list of changes to the readme Add list of 2.x changes to the p5.js-compatibility README Apr 29, 2025
@GregStanton
Copy link

GregStanton commented May 6, 2025

HI @davepagurek and @ksen0! Glad to see this issue.

Spreadsheet -> Markdown?

Maybe as a start, I could add a Markdown document to this repo with all the feature changes we know about, based on the spreadsheet that was being used internally? It's possible that the spreadsheet is still incomplete, but it may be a good starting point, and posting a public version would help if any other contributors want to get involved.

Aside: Documenting other 2.0 changes

Since we're talking about documenting changes, would it make sense to turn the remaining tasks from the 2.0 documentation project into GitHub issues? That way, they could be publicly tracked in p5.js Documentation Update and Organization
. Right now, it looks like the p5.js 2.x project tracker is also being used for this purpose, but maybe we could consolidate documentation issues in the documentation-update project? I'd be happy to post GitHub issues for the remaining work. Here are some examples:

  • Reference updates and fixes
    • p5.Vector (e.g. sub() doesn't indicate support for n-dimensional vectors, clampToZero() is missing, ...)
    • sense checks of all pages (@perminder-17 already identified some problems that need to be fixed)
  • Contributor docs need updates
  • Tutorials (some are still missing)

There are other tasks that I know are already being tracked on GitHub, but I don't think the ones above are currently being tracked, apart from some smaller issues related to broken links: #7220, #7227

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: Open for Discussion
Development

No branches or pull requests

3 participants