Skip to content

Commit 06d68e6

Browse files
committed
feat: extract messenger-docs into publishable package
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.
1 parent 8fccc86 commit 06d68e6

File tree

136 files changed

+19228
-21892
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+19228
-21892
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
/packages/error-reporting-service @MetaMask/core-platform
8181
/packages/eth-json-rpc-middleware @MetaMask/core-platform
8282
/packages/messenger @MetaMask/core-platform
83+
/packages/messenger-docs @MetaMask/core-platform
8384
/packages/sample-controllers @MetaMask/core-platform
8485
/packages/polling-controller @MetaMask/core-platform
8586
/packages/preferences-controller @MetaMask/core-platform

.github/workflows/messenger-docs.yml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,22 @@ jobs:
2323
with:
2424
is-high-risk-environment: false
2525

26-
- name: Generate Messenger docs
27-
run: yarn docs:messenger:generate
28-
29-
- name: Install docs-site dependencies
30-
run: npm --prefix docs-site install
31-
32-
- name: Build Docusaurus site
33-
run: npm --prefix docs-site run build
26+
- name: Generate and build Messenger docs
27+
run: yarn docs:messenger:build
3428

3529
- name: Upload build artifact (PR)
3630
if: github.event_name == 'pull_request'
3731
uses: actions/upload-artifact@v4
3832
with:
3933
name: messenger-api-docs
40-
path: docs-site/build/
34+
path: .messenger-docs/build/
4135
retention-days: 7
4236

4337
- name: Upload Pages artifact (main)
4438
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
4539
uses: actions/upload-pages-artifact@v3
4640
with:
47-
path: docs-site/build/
41+
path: .messenger-docs/build/
4842

4943
deploy:
5044
name: Deploy to GitHub Pages

.gitignore

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,8 @@ scripts/coverage
3737
# typescript
3838
packages/*/*.tsbuildinfo
3939

40-
# Messenger API docs site (generated)
41-
docs-site/docs/
42-
docs-site/sidebars.ts
43-
docs-site/build/
44-
docs-site/.docusaurus/
45-
docs-site/node_modules/
46-
docs-site/package-lock.json
47-
docs-site/.yarn/
40+
# Messenger API docs (generated)
41+
.messenger-docs/
4842

4943
# Emacs
5044
\#*\#

README.md

Lines changed: 2 additions & 0 deletions

docs-site/package.json

Lines changed: 0 additions & 26 deletions
This file was deleted.
-113 KB
Binary file not shown.
-108 KB
Binary file not shown.
-113 KB
Binary file not shown.
-40.3 KB
Binary file not shown.
-28.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)