phetsims / natural-selection

"Natural Selection" is an educational simulation in HTML5, by PhET Interactive Simulations
GNU General Public License v3.0
3 stars 7 forks source link

Revise examples.md for 1.5 release #346

Closed arouinfar closed 1 year ago

arouinfar commented 1 year ago

For #323

The examples.md doc should be updated for the 1.5 release.

TODOs include

pixelzoom commented 1 year ago

For https://github.com/phetsims/qa/issues/967, note that 1.5.0-dev.5 was published before revising examples.md. Please contact @arouinfar for the status of examples.md. It may be ready to review in master by the time that this test is underway.

arouinfar commented 1 year ago

In the above commit, I removed customizations that we wouldn't recommend to clients and some simpler examples covered in the general PhET-iO Guide. I also added examples describing the query parameters. There's still quite a bit to do here, though.

arouinfar commented 1 year ago

I completed the examples doc in the commit above and it is ready for review by QA. I added notes in the main QA issue, pasted here for convenience:

QA, please review examples.md on master. Note that the example links containing {{STUDIO_PATH}} will only work in a built version. To test, please copy and paste the query string yourself.

Nancy-Salpepi commented 1 year ago

For https://github.com/phetsims/qa/issues/967 @arouinfar this phetioID needs to be fixed:

Screenshot 2023-08-03 at 1 45 20 PM
arouinfar commented 1 year ago

Thanks @Nancy-Salpepi! Not sure how that happened, but it's been fixed in the above commit.

Nancy-Salpepi commented 1 year ago

Cool. Shall we close this then?

arouinfar commented 1 year ago

Yes, let's close.

arouinfar commented 1 year ago

Reopening. I goofed and didn't actually format the links like links, so they are showing up like this in the built version:

image
pixelzoom commented 1 year ago

Verified links in https://phet-dev.colorado.edu/html/natural-selection/1.5.0-dev.7/phet-io/doc/guides/examples.html

arouinfar commented 1 year ago

Thanks @pixelzoom. Looks good to me too, closing.