mdn / mdn/webextensions-examples

examples.json should include a way to list significant manifest keys

Open
#524 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement idle
Dominant language
JavaScript
Stars
4.5k
Forks
2.6k
Avg merge
15h 27m
Merged PRs (30d)
3

Description

examples.json lists all samples plus relevant extension APIs in javascript_apis. But there are several extension APIs with significant functionality in its manifest keys. By significant, I mean not just because it is referenced (e.g. name and description are quite meaningless), but because the example is a notably good demonstration of the APIs in use.

To make it easier to find the right examples, we should introduce a new key, e.g. manifest_keys to link examples to manifest keys.

Tasks:

Example of expected results:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with CONTRIBUTING and examples.json in mdn/webextensions-examples, then inspect the WebExtAllExamples.ejs and WebExtExamples.ejs macros in mdn/yari. Review the protocol_handlers manifest documentation in mdn/content as the reference case. Done means significant manifest keys are recorded, both macros parse them, and the relevant documentation pages render the examples and manifest key in their tables.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.