phetsims / friction

"Friction" is an educational simulation in HTML5, by PhET Interactive Simulations.
http://phet.colorado.edu/en/simulation/friction
GNU General Public License v3.0
4 stars 6 forks source link

PhET-iO guide does not exist #316

Closed KatieWoe closed 1 year ago

KatieWoe commented 1 year ago

Device Samsung OS Win 11 Browser Chrome Problem Description For https://github.com/phetsims/qa/issues/868 The link to the PhET-iO Guide leads to a 404 error.

zepumph commented 1 year ago

Thanks! There was an assumption that you needed an entry in phet-io-sim-specific to get a client guide, but now that is a generated and general resource for all sims, so I updated it so that you don't need a folder in phet-io-sim-specific to get that doc. This is the first sim of the new paradigm. While I was there I also simplified some elements in the process. This is cleanup that probably should have happened around the GAO publication process, but we didn't make the time for it. Now examples are in top level of each sim dir, and that is the only sim-specific file, since we don't need sim-specific images as far as I know.

zepumph commented 1 year ago

I discussed with @arouinfar and we agree about the current state of creating and maintaining client guides, I updated the README accordingly. I confirmed that friction is getting a phet-io guide now and has examples (the file and a row in the index). Closing