From efa94adf95bfdae17fc370c4b06f3b600c8285a8 Mon Sep 17 00:00:00 2001 From: Salah-Eddine Saakoun Date: Fri, 12 Jun 2026 16:17:18 +0200 Subject: [PATCH 1/2] chore: add typedoc.json configuration 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). --- CHANGELOG.md | 4 ++++ typedoc.json | 7 +++++++ 2 files changed, 11 insertions(+) create mode 100644 typedoc.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 88cc730f..7b884a45 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- Add `typedoc.json` configuration for API doc generation ([#TBD](https://github.com/MetaMask/smart-transactions-controller/pull/TBD)) + ### Changed - Bump `@metamask/controller-utils` from `^12.1.0` to `^12.2.0` ([#590](https://github.com/MetaMask/smart-transactions-controller/pull/590)) diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..c9da015d --- /dev/null +++ b/typedoc.json @@ -0,0 +1,7 @@ +{ + "entryPoints": ["./src/index.ts"], + "excludePrivate": true, + "hideGenerator": true, + "out": "docs", + "tsconfig": "./tsconfig.build.json" +} From 5b2395cc2fc5c7122dca3ba7891f8ec9d0a1b081 Mon Sep 17 00:00:00 2001 From: Salah-Eddine Saakoun Date: Fri, 12 Jun 2026 16:18:08 +0200 Subject: [PATCH 2/2] chore: link changelog entry to PR #592 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b884a45..de45e9b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add `typedoc.json` configuration for API doc generation ([#TBD](https://github.com/MetaMask/smart-transactions-controller/pull/TBD)) +- Add `typedoc.json` configuration for API doc generation ([#592](https://github.com/MetaMask/smart-transactions-controller/pull/592)) ### Changed