document relationship between images and assets

[pixelzoom]

Related to code review #247

• Is there a file in assets/ for every resource file in sound/ and images/? Note that there is not necessarily a 1:1 correspondence between asset and resource files; for example, several related images may be in the same .ai file. Check license.json for possible documentation of why some resources might not have a corresponding asset file.

In #243 (self code review), @chrisklus noted:

UPDATE: Nope, and I don't think this could be done easily or is worth the design time. Some of the images used are pretty old and are without .ai files.

This is not an acceptable answer. This sim has a whopping 104 images files. Not only is there no documentation in license.json about which asset files correspond to each image, there is no documentation about which images do not have a corresponding asset file.

And for images that don't have an assert file... Is it possible that these asset files live in Unfuddle but haven't been moved over to GitHub? I see 13 .ai files in Unfuddle that do not live in GitHub.

[chrisklus]

In #243 (self code review), @chrisklus noted:

UPDATE: Nope, and I don't think this could be done easily or is worth the design time. Some of the images used are pretty old and are without .ai files.

This is not an acceptable answer. This sim has a whopping 104 images files.

Understood - I didn't know this was a big deal. During the development of the sim, whenever we had to change one of the original images, @arouinfar just made a new one since we didn't have the original .ai files and since they typically had an outdated look.

Not only is there no documentation in license.json about which asset files correspond to each image, there is no documentation about which images do not have a corresponding asset file.

I didn't know we had a convention for linking images to assets in the license file. That sounds very nice and helpful. I'll do this as part of the work for this issue.

And for images that don't have an assert file... Is it possible that these asset files live in Unfuddle but haven't been moved over to GitHub? I see 13 .ai files in Unfuddle that do not live in GitHub.

I'm unfamiliar with Unfuddle but will have someone help me look for them there.

[chrisklus]

Per discussion with @ariel-phet before 08/22/19 dev meeting, we won't have time for cleanup in this issue and #250 before starting PhET-iO instrumentation. Updating to low priority.

[chrisklus]

Leaving this issue unassigned until work on this sim is scheduled.