Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Add explanation of Svg folders in README or SharedAssets.md #262

Open
Tracked by #265
MartinZikmund opened this issue May 6, 2024 · 5 comments
Open
Tracked by #265
Labels
kind/enhancement New feature or request. triage/untriaged Indicates an issue requires triaging or verification.

Comments

@MartinZikmund
Copy link
Member

MartinZikmund commented May 6, 2024

What would you like to be added:

The fact that folders named Svg are ignored by Resizetizer by default should be clearly mentioned in the default generated project as part of a README or SharedAssets.md

A guidance or even default folder in the template where .svg would be ignored by Resizetizer.

Reasoning behind this is that in WinUI .svgs are just content files by default. Currently .svgs in our case are resized by default, which is a discrepancy.

Maybe it would make sense to include a folder like Assets/Svg in the project template with a README that says that .svg in that location is not resized

@MartinZikmund MartinZikmund added kind/enhancement New feature or request. triage/untriaged Indicates an issue requires triaging or verification. labels May 6, 2024
@dansiegel
Copy link
Contributor

@MartinZikmund this sounds like it has nothing to do with Resizetizer. By default Resizetizer doesn't do anything. The SDK does provide default includes. By default the SDK excludes adding UnoImage's in $(AssetsFolder)\**\Svg\*.svg which would seem to already be doing what you're asking for.

@MartinZikmund
Copy link
Member Author

Ah, in that case I this will mainly be docs I guess (maybe I have missed this somewhere, but if not yet documented, that would be useful). And having such folder with a README in template could be nice as well, for out of the box clarity

@MartinZikmund MartinZikmund changed the title [Resizetizer] Opt-in behavior for a folder [Doc] Default SDK excludes for Svg folders May 6, 2024
@agneszitte
Copy link
Contributor

agneszitte commented May 6, 2024

@MartinZikmund he is the current doc https://platform.uno/docs/articles/features/svg.html?tabs=singleproject#how-to-use-svg
image
Let me know if you think we should make things clearer as needed.


And I agree with you @MartinZikmund, a default README (mentioning details about assets, resizetizer, svg,...) in the template would be helpful as right now we currently only have the SharedAssets.md with these details:
image
cc @jeromelaban

@MartinZikmund
Copy link
Member Author

Great that we have docs 👍

@agneszitte
Copy link
Contributor

agneszitte commented May 8, 2024

@jeromelaban, @MartinZikmund, @dansiegel
I think we should open a proper issue to add a default README (mentioning details + links for the doc about assets, resizetizer, SVG,...) in the template.
It would be helpful as right now we currently only have the SharedAssets.md with these details:
image

@MartinZikmund MartinZikmund reopened this May 9, 2024
@MartinZikmund MartinZikmund changed the title [Doc] Default SDK excludes for Svg folders [Doc] Add explanation of Svg folders in README or SharedAssets.md May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request. triage/untriaged Indicates an issue requires triaging or verification.
Projects
None yet
Development

No branches or pull requests

3 participants