chore: add typedoc.json configuration#592
Merged
Merged
Conversation
Adds the TypeDoc configuration file expected by the MetaMask core monorepo's package conventions, in preparation for migration. The file is wired up to typedoc tooling once the package lands in core (Phase B PR #9 of the migration guide).
Mrtenz
approved these changes
Jun 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Explanation
Adds the TypeDoc configuration file expected by the MetaMask core monorepo's package conventions (scripts/create-package/package-template/typedoc.json).
The file is a static configuration — no wiring is added here because the source repo doesn't currently consume it. TypeDoc tooling (and a
build:docsscript) will be enabled once the package lands in core (Phase B PR #9 of the migration guide).References
metamask-module-template)Note
Low Risk
Static documentation config and changelog only; no runtime or build behavior changes in this repository.
Overview
Adds a
typedoc.jsonconfig aligned with MetaMask core package conventions so API docs can be generated from./src/index.tsintodocs, usingtsconfig.build.json, hiding private symbols and the TypeDoc generator banner.Documents the addition under Unreleased → Added in
CHANGELOG.md. Nobuild:docsscript or TypeDoc dependency is wired in this repo yet; that is expected to follow when the package lands in core.Reviewed by Cursor Bugbot for commit 5b2395c. Bugbot is set up for automated code reviews on this repo. Configure here.