MetaMask / MetaMask/core

Generate Messenger API documentation

Open
#5,628 10 comments 0 reactions 1 assignee View on GitHub

@cryptodev-2s is already working on this.

Since May 15, 2025.

team-wallet-framework wf-messenger
Dominant language
TypeScript
Stars
413
Forks
308
Avg merge
1d 4h
Merged PRs (30d)
253

Description

## Problem

To make the Wallet Framework a success, we want developers to use the messenger within the UI and other places. However, currently, it is very difficult for them to understand what sorts of actions and events are available, and it is even more difficult to understand what each action and event does.

## Solution

To fix this, we want to build a live-updating documentation system for each client that listens for a new commit, looks at the messenger actions and events present in the global messenger, collects their TSDoc/JSDoc blocks from the packages where those actions and events come from, and organizes them into a site. A new version of this site should be deployed for each commit in the repo.

The goal of this ticket is to work out a POC that operates on the messenger actions and events available across packages in this monorepo and to work out how the site should be automatically built and deployed.

## Acceptance Criteria

- When a new commit shows up on `main`, JSDoc blocks for all messenger action and event types across all packages in the monorepo should be collected and compiled into a site, which should be deployed to GitHub Pages
- When a new commit shows up in a pull request, the same thing should happen, but the site should be stored in an artifact. The user can then download the artifact to load the docsite locally.

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.