Skip to content

Conversation

@superdump
Copy link
Contributor

No description provided.

@doup
Copy link
Contributor

doup commented Feb 22, 2023

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.

@alice-i-cecile
Copy link
Member

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

@superdump
Copy link
Contributor Author

Done.

@mockersf
Copy link
Member

mockersf commented Feb 22, 2023

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.

@doup
Copy link
Contributor

doup commented Mar 15, 2023

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

@mockersf
Copy link
Member

rust-lang/rfcs#3397
It also mentions a few alternatives that would work today

@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review Ready for a maintainer to consider for merging label May 1, 2024
@alice-i-cecile alice-i-cecile enabled auto-merge May 1, 2024 19:39
@alice-i-cecile alice-i-cecile disabled auto-merge May 1, 2024 19:39
@alice-i-cecile alice-i-cecile enabled auto-merge May 13, 2024 17:44
@alice-i-cecile alice-i-cecile added this pull request to the merge queue May 13, 2024
Merged via the queue into bevyengine:main with commit c3f4963 May 13, 2024
@Selene-Amanita
Copy link
Member

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 bevyengine/bevy#9061 )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Book C-Webdev S-Ready-For-Final-Review Ready for a maintainer to consider for merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants