search

pwa-builder / PWABuilder

The simplest way to create progressive web apps across platforms and devices. Start here. This repo is home to several projects in the PWABuilder family of tools.
https://docs.pwabuilder.com
Other
2.75k stars 285 forks source link

[DOCS] Improve "asset links" section in android.md by replacing <URL to your PWA> by <Host URL of your PWA> #4832

Open clementlize opened 1 week ago

clementlize commented 1 week ago

What's your suggestion for improvement for our docs?

Let's say my app is deployed on https://example.com/development.app

In the Android section of the site builder, I would fill these fields:

I would then want to set the "asset links" to remove the Chrome URL top bar, so going to the documentation I see this:

To properly deploy this file, upload it to your server at https://<URL to your PWA>/.well-known/assetlinks.json.

So I'd go to my hosting and create the file at www/development.app/.well-known/assetlinks.json where www is the root folder of my web server. I would then test the URL https://example.com/development.app/.well-known/assetlinks.json and see that I can get the file from my browser.

But the URL app would not disappear!

In fact, the Android app expects this file to be located in a .well-known directory directly under the host domain. So I move my file to www/.well-known/assetlinks.json (full URL is now https://example.com/.well-known/assetlinks.json ) and it works now.

I think it would be better to include this host precision in the documentation. The line in android.md would become:

To properly deploy this file, upload it to your server at https://<Host URL of your PWA>/.well-known/assetlinks.json.

Do you have an implementation or a solution in mind?

No response

Have you considered any alternatives?

No response

microsoft-github-policy-service[bot] commented 10 hours ago

This issue has been marked as "needs attention 👋" since it has not been triaged for 7 days. Please triage the issue .