diff --git a/packages/platform-api-docs/CHANGELOG.md b/packages/platform-api-docs/CHANGELOG.md index 18d0182c352..dc6fb9d7a20 100644 --- a/packages/platform-api-docs/CHANGELOG.md +++ b/packages/platform-api-docs/CHANGELOG.md @@ -9,6 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Initial release of the platform-api-docs package ([#8012](https://github.com/MetaMask/core/pull/8012)) +- Initial release of the platform-api-docs package ([#8012](https://github.com/MetaMask/core/pull/8012), [#9913](https://github.com/MetaMask/core/pull/9913)) [Unreleased]: https://github.com/MetaMask/core/ diff --git a/packages/platform-api-docs/README.md b/packages/platform-api-docs/README.md index 2abc7e405b1..a85710ba948 100644 --- a/packages/platform-api-docs/README.md +++ b/packages/platform-api-docs/README.md @@ -35,12 +35,61 @@ Options: --build Generate docs and build static site --serve Generate docs, build, and serve static site --dev Generate docs and start dev server with hot reload - --scan-dir Extra source directory to scan (repeatable) + --strategy How to find actions and events: "scan" (default) or + "root-messenger" (see below) + --scan-dir Extra source directory to scan (repeatable; --strategy scan only) + --root-actions Type aliasing the union of every action, as "#" + (required with --strategy root-messenger) + --root-events Type aliasing the union of every event, as "#" + (required with --strategy root-messenger) --output Output directory (default: /.platform-api-docs) --project-label