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: replaced '<URL to your PWA>' by '<Host URL of your PWA>' in andr… #4833

Merged
merged 2 commits into from
Oct 29, 2024

Conversation

clementlize
Copy link
Contributor

fixes #4832

PR Type

  • Documentation content changes

Describe the current behavior?

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

Describe the new behavior?

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

PR Checklist

  • Test: run npm run test and ensure that all tests pass
  • Target main branch (or an appropriate release branch if appropriate for a bug fix)
  • Ensure that your contribution follows standard accessibility guidelines. Use tools like https://webhint.io/ to validate your changes.

Additional Information

Copy link
Contributor

@jgw96 jgw96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey! I really appreciate you making this PR. I'm wondering if we could make this even better actually, if you have time for more changes of course. I'm thinking it might be better to explain what the Host URL is in this context, as that might help people avoid the issue without having to know what Host URL means. Let me know what you think, maybe I am overthinking this (:

@clementlize
Copy link
Contributor Author

Hi @jgw96

I don't think you're overthinking, it could be great to remind what's the host.
To me it seemed obvious because I just built the PWA with the website and it specifically asks to split host and path, so I had it on my mind.

I'll take time this week to try and explain a bit in the md file

@jgw96
Copy link
Contributor

jgw96 commented Oct 15, 2024

Sounds good! Let me know if you need any help etc 😊

…oid docs to improve comprehension of where to put the file
@clementlize
Copy link
Contributor Author

@jgw96 Hi there, I updated the PR with a better commit that

  • Removes https before <URL> (because protocol is part of the URL!)
  • Replaces <URL to your PWA> by <Host URL of your PWA> (1st intention of this PR)
  • Adds a note block explaining what is the Host URL with an example
  • Turns the Digital asset links are required for your PWA message from note to important block, because well it's very important to my mind and it renders better with the new note block just above

@jgw96 jgw96 added this pull request to the merge queue Oct 29, 2024
@jgw96
Copy link
Contributor

jgw96 commented Oct 29, 2024

thank you!!!!!

Merged via the queue into pwa-builder:main with commit 1152cfb Oct 29, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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