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

[davepagurek]

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.

[ksen0]

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

[ksen0]

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

[GregStanton]

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
    • descriptions may mention x, y, z but not support for n-dimensional vectors (e.g. in sub())
    • clampToZero() is missing
    • mult() examples disappeared along with some of its description
    • etc.
  • sense checks of all pages (@perminder-17 already identified some problems that need to be fixed)
• Contributor docs need updates
  • YUIDoc is still mentioned
  • outdated FES files are referred to
  • new system for add-on libraries not documented in "Creating an Addon Library" (maybe the dev.to write-up could help)
  • new test framework (docs still refer to Mocha)
  • New benchmarking system? I haven't looked into this, but the proposal to expand performance profiling was closed as completed, so I guess we have something worth documenting?
• 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

[ksen0]

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

That sounds great, please go ahead, do you think it should be an additional .md file or a wiki page? .md file seems more findable, but I'm open to ideas.

Right now, it looks like the p5.js 2.x 🌱🌳 is also being used for this purpose, but maybe we could consolidate documentation issues in the documentation-update project?

Anything that's help wanted and good first issue can be cross-posted on both boards, since I'm using the 2.x status board as the main link to invite contributors, and it should ideally include documentation tasks

new system for add-on libraries not documented in "Creating an Addon Library" (maybe the dev.to write-up could help)

Recently created, also relevant: processing/p5.js#7798

[quinton-ashley]

Mentioning that p5 v2 doesn't add instance props to the global scope anymore would be good.