bevy-website icon indicating copy to clipboard operation
bevy-website copied to clipboard

Published 20 hours ago • verified publisher icon bevyengine

Add tonemapping example images for use in the book and rustdoc

Open superdump opened this issue 2 years ago • 6 comments
trafficstars

superdump avatar Feb 21 '23 23:02 superdump

If these are going to be referenced from the API reference (not the website docs) then I think it's better to move it into a separate assets-docs folder so it's not removed in case there is a website redesign (or tooling is used to optimize the website assets, etc.).

If this approach is used, then I would also add a assets-docs/README.md to explain the purpose of this folder.

doup avatar Feb 22 '23 09:02 doup

Seconding doup's suggestion. Once that's done this LGTM.

alice-i-cecile avatar Feb 22 '23 15:02 alice-i-cecile

Done.

superdump avatar Feb 22 '23 22:02 superdump

Do we have an idea on how to handle versioning if we notice a bug in how those images were generated and need to be updated, but still have to link to a before fix version in the corresponding docs? I think putting the version of Bevy used to generate them either in a folder or in the filename could be a start.

mockersf avatar Feb 22 '23 23:02 mockersf

Maybe just version the files like foo.v0.webp? Without adding a relation to any Bevy version.

doup avatar Mar 15 '23 09:03 doup

https://github.com/rust-lang/rfcs/pull/3397 It also mentions a few alternatives that would work today

mockersf avatar Mar 17 '23 02:03 mockersf

A bit late to the party:

This image should probably be moved there too: https://github.com/bevyengine/bevy/tree/main/assets/docs ?

(Created in https://github.com/bevyengine/bevy/pull/9061 )

Selene-Amanita avatar May 13 '24 18:05 Selene-Amanita