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

PWA icon options are not clearly explained in docs #5407

Closed
DRBragg opened this issue Apr 20, 2020 · 1 comment · Fixed by #5408
Closed

PWA icon options are not clearly explained in docs #5407

DRBragg opened this issue Apr 20, 2020 · 1 comment · Fixed by #5408

Comments

@DRBragg
Copy link
Contributor

DRBragg commented Apr 20, 2020

What problem does this feature solve?

Per the conversation in issues #4069 and my own experience, the current documentation on icons for the PWA plugin does not clearly explain the difference between pwa.iconPaths and pwa.manifestOptions.icons. In fact pwa.manifestOptions.icons isn't actually mentioned in the docs.

What does the proposed API look like?

Simply adding a note to the pwa.iconPaths section explaining what these icon paths do and adding pwa.manifestOptions.icons to the pwa.manifestOptions section should solve most peoples confusion.

@DRBragg
Copy link
Contributor Author

DRBragg commented Apr 24, 2020

@LinusBorg I opened PR #5408 that I think solves this problem. I'm open to feedback if it isn't good enough or clear enough.

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

Successfully merging a pull request may close this issue.

2 participants