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

Native Messaging documentation can be more explicit about the location of application manifest #22534

Open
abhn opened this issue Nov 25, 2022 · 0 comments
Labels
Content:WebExt WebExtensions docs help wanted If you know something about this topic, we would love your help! p4 A minor issue on a Tier 2 MDN doc.

Comments

@abhn
Copy link
Contributor

abhn commented Nov 25, 2022

MDN URL

https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging

What specific section or headline is this issue about?

App manifest

What information was incorrect, unhelpful, or incomplete?

The app manifest file must be installed along with the native application. The browser reads and validates app manifest files, but it does not install or manage them. The security model for when and how these files are installed and updated is much more like that for native applications than that for extensions using WebExtension APIs.

This section doesn't make it explicitly clear that the app manifest has to be present in a very particular location on the operating system, depending on the operating system. Clicking on the link in the next paragragh

For details of native app manifest syntax and location, see Native manifests.

And scrolling all the way down to Manifest Location > Mac OS is when that detail is revealed which is a bit hidden in my opinion.

What did you expect to see?

In my case, I had a script that needed to be run and exchange message with the browser, and I spent a lot of time looking for how exactly will the browser read my manifest (or that I was supposed to put it somewhere very specific).

I expected a warning that said "made sure the app manifest is added to the right directory and check if that's the case using the following steps". I discovered it upon clicking the more Native Manifests, and reading through it.

I guess it was just because I was using native messaging for the first time, but I thought that could be the case with many.

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

MDN metadata

Page report details
@github-actions github-actions bot added needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. Content:WebExt WebExtensions docs labels Nov 25, 2022
@sideshowbarker sideshowbarker added help wanted If you know something about this topic, we would love your help! and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Nov 27, 2022
@rebloor rebloor added the p4 A minor issue on a Tier 2 MDN doc. label Dec 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebExt WebExtensions docs help wanted If you know something about this topic, we would love your help! p4 A minor issue on a Tier 2 MDN doc.
Projects
None yet
Development

No branches or pull requests

3 participants