Merge branch 'MetaMask:main' into main

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+# Description
+
+<!-- Describe the changes made in your pull request (PR). -->
+
+## Issue(s) fixed
+
+<!-- Include the issue number that this PR fixes. -->
+
+Fixes #
+
+## Preview
+
+<!-- Provide a PR preview link to the page(s) changed. -->
+
+## Checklist
+
+Complete this checklist before merging your PR:
+
+- [ ] If this PR contains a major change to the documentation content, I have added an entry to the top of the ["What's new?"](https://github.com/MetaMask/metamask-docs/blob/main/docs/whats-new.md) page.
+- [ ] The proposed changes have been reviewed and approved by a member of the documentation team.

.github/workflows/crowdin.yml

@@ -0,0 +1,32 @@
+name: Crowdin Action
+
+on:
+  push:
+    path: [ "i18n/**" ]
+    branches: [ main ]
+
+permissions: write-all
+
+jobs:
+  crowdin:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Synchronize with Crowdin
+        uses: crowdin/github-action@v1
+        with:
+          upload_sources: true
+          upload_translations: true
+          download_translations: true
+          localization_branch_name: l10n_crowdin_translations
+
+          create_pull_request: true
+          pull_request_title: 'New Crowdin translations'
+          pull_request_body: 'New Crowdin pull request with translations'
+          pull_request_base_branch_name: 'main'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
+          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

crowdin.yml

@@ -0,0 +1,16 @@
+project_id_env: CROWDIN_PROJECT_ID
+api_token_env: CROWDIN_PERSONAL_TOKEN
+preserve_hierarchy: true
+files:
+  # JSON translation files
+  - source: /i18n/en/**/*
+    translation: /i18n/%two_letters_code%/**/%original_file_name%
+  # Docs Markdown files
+  - source: /wallet/**/*
+    translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
+  - source: /snaps/**/*
+    translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
+  - source: /services/**/*
+    translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%
+  - source: /docs/**/*
+    translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/**/%original_file_name%

docs/whats-new.md

@@ -9,8 +9,41 @@ The latest major MetaMask documentation updates are listed by the month they wer
 For a comprehensive list of recent product changes, visit the "Release Notes" section at the bottom
 of the [MetaMask developer page](https://metamask.io/developer/).
 
+## May 2024
+
+- Documented [provider API methods for removing event listeners](/wallet/reference/provider-api/#remove-event-listeners).
+  ([#1288](https://github.com/MetaMask/metamask-docs/pull/1288))
+
+## April 2024
+
+- Documented [Snaps notifications](/snaps/features/notifications).
+  ([#1292](https://github.com/MetaMask/metamask-docs/pull/1292))
+- Moved Snaps-specific Wallet API methods from the
+  [Wallet JSON-RPC API reference](/wallet/reference/json-rpc-api) to the
+  [Snaps reference](/snaps/reference/wallet-api-for-snaps).
+  ([#1286](https://github.com/MetaMask/metamask-docs/pull/1286))
+- Documented [Snaps `onKeyringRequest` entry point](/snaps/reference/entry-points/#onkeyringrequest).
+  ([#1258](https://github.com/MetaMask/metamask-docs/pull/1258))
+- Documented [Snaps data storage](/snaps/features/data-storage).
+  ([#1278](https://github.com/MetaMask/metamask-docs/pull/1278))
+- Documented [how to get your Snap allowlisted](/snaps/how-to/get-allowlisted).
+  ([#1222](https://github.com/MetaMask/metamask-docs/pull/1222))
+- Documented [Snaps lifecycle hooks](/snaps/features/lifecycle-hooks).
+  ([#1274](https://github.com/MetaMask/metamask-docs/pull/1274))
+- Documented [Snaps cron jobs](/snaps/features/cron-jobs).
+  ([#1271](https://github.com/MetaMask/metamask-docs/pull/1271))
+- Updated [how to connect to MetaMask](/wallet/how-to/connect) with vanilla TypeScript and React
+  TypeScript instructions.
+  ([#1247](https://github.com/MetaMask/metamask-docs/pull/1247))
+
 ## March 2024
 
+- Documented [Snaps `polyfills` configuration option](/snaps/reference/cli/options/#polyfills).
+  ([#1238](https://github.com/MetaMask/metamask-docs/pull/1238))
+- Documented [Snaps interactive UI](/snaps/features/custom-ui/interactive-ui).
+  ([#1166](https://github.com/MetaMask/metamask-docs/pull/1166))
+- Documented [Snaps improved image support](/snaps/features/custom-ui/#image).
+  ([#1236](https://github.com/MetaMask/metamask-docs/pull/1236))
 - Documented [Snaps signature insights](/snaps/features/signature-insights).
   ([#1228](https://github.com/MetaMask/metamask-docs/pull/1228))
 - Documented [how to restrict a Snap's RPC API methods](https://github.com/MetaMask/metamask-docs/pull/1223).
@@ -62,7 +95,14 @@ of the [MetaMask developer page](https://metamask.io/developer/).
   ([#1129](https://github.com/MetaMask/metamask-docs/pull/1129))
 - Added [Snaps architecture diagrams](/snaps/learn/about-snaps).
   ([#1123](https://github.com/MetaMask/metamask-docs/pull/1123))
+- Documented [Snaps unencrypted state](/snaps/reference/snaps-api/#snap_managestate).
+  ([#1124](https://github.com/MetaMask/metamask-docs/pull/1124))
 - Documented [`snap_getClientStatus`](/snaps/reference/snaps-api/#snap_getclientstatus).
   ([#1119](https://github.com/MetaMask/metamask-docs/pull/1119))
+- Restructured and improved [Wallet documentation](/wallet) and introduced "Wallet API" terminology.
+  ([#1114](https://github.com/MetaMask/metamask-docs/pull/1114) and
+  [#1125](https://github.com/MetaMask/metamask-docs/pull/1125))
 - Documented [how to detect multiple wallets using EIP-6963](/wallet/how-to/connect).
   ([#1094](https://github.com/MetaMask/metamask-docs/pull/1094))
+- Documented [how to communicate errors in Snaps](/snaps/how-to/communicate-errors).
+  ([#1117](https://github.com/MetaMask/metamask-docs/pull/1117))

docusaurus.config.js

@@ -25,7 +25,7 @@ const config = {
   // to replace "en" with "zh-Hans".
   i18n: {
     defaultLocale: "en",
-    locales: ["en"],
+    locales: ["en"/*, "ru", "zh"*/],
   },
 
   trailingSlash: true,
@@ -61,7 +61,7 @@ const config = {
             }],
           ],
           openrpc: {
-            openrpcDocument: "https://metamask.github.io/api-specs/latest/openrpc.json",
+            openrpcDocument: "https://metamask.github.io/api-specs/0.8.4/openrpc.json",
             path: "reference",
             sidebarLabel: "JSON-RPC API",
           },
@@ -426,6 +426,12 @@ const config = {
             label: "What's new?",
             position: "right",
           },
+          /* Language drop down
+          {
+            type: "localeDropdown",
+            position: "right",
+          },
+          */
         ],
       },
       docs: {
@@ -455,7 +461,7 @@ const config = {
               },
               {
                 label: "MetaMask SDK",
-                to: "/sdk",
+                to: "/wallet/how-to/use-sdk",
               },
               {
                 label: "Snaps",