mdn/content

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

Open

#22,534 opened on Nov 25, 2022

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Markdown (22,427 forks)batch import
Content:WebExthelp wantedp2

Repository metrics

Stars
 (8,900 stars)
PR merge metrics
 (Avg merge 7d 3h) (147 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Read the current documentation at the given section on Native Messaging. Identify where to add a warning or note about the manifest file needing to be in a specific OS dependent location. Write a concise sentence or two that makes this explicit, and optionally add a link to the 'Native manifests' page for details. Consider adding a 'Warning' or 'Note' callout.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85