feat: extract messenger-docs into publishable package#8014
Draft
cryptodev-2s wants to merge 4 commits intofeat/messenger-docs-sitefrom
Draft
feat: extract messenger-docs into publishable package#8014cryptodev-2s wants to merge 4 commits intofeat/messenger-docs-sitefrom
cryptodev-2s wants to merge 4 commits intofeat/messenger-docs-sitefrom
Conversation
Contributor
Author
|
@metamaskbot publish-preview |
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
6c2c215 to
15feaa9
Compare
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
15feaa9 to
e117c81
Compare
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
e117c81 to
ceb233c
Compare
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
All alerts resolved. Learn more about Socket for GitHub. This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. Ignoring alerts on:
|
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
ceb233c to
06d68e6
Compare
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Contributor
Author
|
@SocketSecurity ignore npm/prettier@3.8.1 |
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
06d68e6 to
56789ec
Compare
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
cryptodev-2s
force-pushed
the
feat/messenger-docs-site
branch
from
8fccc86 to
445fe2b
Compare
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
658f090 to
90231c5
Compare
Contributor
Author
|
@metamaskbot publish-preview |
cryptodev-2s
force-pushed
the
feat/messenger-docs-site
branch
from
445fe2b to
b55b682
Compare
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
90231c5 to
deea129
Compare
Contributor
Author
|
@metamaskbot publish-preview |
cryptodev-2s
force-pushed
the
feat/messenger-docs-site
branch
from
b55b682 to
980f677
Compare
Move messenger docs generation from scripts/generate-messenger-docs/ and docs-site/ into packages/messenger-docs/ as a standalone CLI tool that can be used by any project with @MetaMask controller dependencies.
…ences - Scan both packages/ and node_modules/ automatically (remove --source flag) - Keep full JSDoc including deprecation details in generated docs - Convert backtick-quoted names to clickable links when they match known actions/events - Add shebang for npx compatibility
cryptodev-2s
force-pushed
the
feat/messenger-docs-package
branch
from
deea129 to
1883b29
Compare
Contributor
Author
|
@metamaskbot publish-preview |
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
1 participant
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
The messenger docs generation currently lives in
scripts/generate-messenger-docs/and the Docusaurus site template indocs-site/. This makes it unusable by external clients (metamask-extension, metamask-mobile) without access to this monorepo.This PR extracts both into a new
@metamask/messenger-docspackage atpackages/messenger-docs/with a CLI, so any project with@metamaskcontroller dependencies can generate and serve messenger API docs.Usage
References
feat/messenger-docs-siteChecklist