Skip to content

Commit b4f81e7

Browse files
authored
Merge branch 'main' into 2483-embedded-wallets-pass
2 parents a24a539 + 5445c45 commit b4f81e7

File tree

124 files changed

+2891
-1848
lines changed

Some content is hidden

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

124 files changed

+2891
-1848
lines changed

.github/workflows/ci.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
name: Build
2020
runs-on: ubuntu-latest
2121
steps:
22-
- uses: actions/checkout@v5
22+
- uses: actions/checkout@v6
2323
- name: Build
2424
uses: ConsenSys/github-actions/docs-build@main
2525

@@ -30,7 +30,7 @@ jobs:
3030
matrix:
3131
folder: ['docs']
3232
steps:
33-
- uses: actions/checkout@v5
33+
- uses: actions/checkout@v6
3434
- name: Case check action
3535
uses: ConsenSys/github-actions/docs-case-check@main
3636
with:
@@ -41,7 +41,7 @@ jobs:
4141
name: Lint Code Base
4242
runs-on: ubuntu-latest
4343
steps:
44-
- uses: actions/checkout@v5
44+
- uses: actions/checkout@v6
4545
- name: Lint
4646
uses: ConsenSys/github-actions/docs-lint-all@main
4747

@@ -52,7 +52,7 @@ jobs:
5252
matrix:
5353
file-extensions: ['.md', '.mdx']
5454
steps:
55-
- uses: actions/checkout@v5
55+
- uses: actions/checkout@v6
5656
- name: Vale
5757
uses: Consensys/github-actions/docs-spelling-check@main
5858
with:
@@ -62,7 +62,7 @@ jobs:
6262
name: Link Checking
6363
runs-on: ubuntu-latest
6464
steps:
65-
- uses: actions/checkout@v5
65+
- uses: actions/checkout@v6
6666
- name: LinkCheck
6767
uses: ConsenSys/github-actions/docs-link-check@main
6868
with:

.github/workflows/crowdin.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- name: Checkout
15-
uses: actions/checkout@v5
15+
uses: actions/checkout@v6
1616

1717
- name: Synchronize with Crowdin
1818
uses: crowdin/github-action@v2

.github/workflows/dependency_review.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
permissions:
1717
contents: read
1818
steps:
19-
- uses: actions/checkout@v5
19+
- uses: actions/checkout@v6
2020

2121
- name: Dependency review
2222
uses: ConsenSys/github-actions/js-dependency-review@main

.github/workflows/nightly.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
permissions:
1818
contents: read
1919
steps:
20-
- uses: actions/checkout@v5
20+
- uses: actions/checkout@v6
2121
- name: LinkCheck mdx files
2222
uses: ConsenSys/github-actions/docs-link-check@main
2323
with:
@@ -32,7 +32,7 @@
3232
permissions:
3333
contents: read
3434
steps:
35-
- uses: actions/checkout@v5
35+
- uses: actions/checkout@v6
3636
- name: LinkCheck md files
3737
uses: ConsenSys/github-actions/docs-link-check@main
3838
with:

.github/workflows/security-code-scanner.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
contents: read
1818
security-events: write
1919
steps:
20-
- uses: actions/checkout@v5
20+
- uses: actions/checkout@v6
2121
- name: MetaMask Security Code Scanner
2222
uses: ConsenSys/github-actions/mm-security-scanner@main
2323
with:

.github/workflows/trivy-cache.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ jobs:
1414
name: Run trivy scanner
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: actions/checkout@v5
17+
- uses: actions/checkout@v6
1818
- name: Trivy Cache
1919
uses: ConsenSys/github-actions/trivy-update-cache@main

.github/workflows/trivy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
name: Run trivy scanner
1111
runs-on: ubuntu-latest
1212
steps:
13-
- uses: actions/checkout@v5
13+
- uses: actions/checkout@v6
1414
- name: Trivy
1515
uses: ConsenSys/github-actions/trivy@main
1616
with:

docusaurus.config.js

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@ const config = {
105105
SENTRY_KEY: process.env.SENTRY_KEY,
106106
LINEA_ENS_URL: process.env.LINEA_ENS_URL,
107107
SEGMENT_ANALYTICS_KEY: process.env.SEGMENT_ANALYTICS_KEY,
108+
DISCOURSE_API_KEY: process.env.DISCOURSE_API_KEY,
109+
DISCOURSE_API_USERNAME: process.env.DISCOURSE_API_USERNAME,
110+
DISCOURSE_CATEGORY_ID: process.env.DISCOURSE_CATEGORY_ID,
108111
},
109112

110113
trailingSlash: true,
@@ -317,6 +320,164 @@ const config = {
317320
containerId: 'GTM-5FGPLC2Q',
318321
},
319322
],
323+
[
324+
'docusaurus-plugin-llms',
325+
{
326+
// Set docsDir to site root to collect from all directories
327+
docsDir: '.',
328+
// Disable default files since we're generating section-specific files
329+
generateLLMsTxt: false,
330+
generateLLMsFullTxt: false,
331+
// Ignore common non-doc directories
332+
// Note: src/pages/** is not ignored so tutorials can be collected
333+
// Each customLLMFiles entry filters by includePatterns, so only matching files are included
334+
ignoreFiles: [
335+
'node_modules/**',
336+
'build/**',
337+
'.docusaurus/**',
338+
'static/**',
339+
'src/components/**',
340+
'src/theme/**',
341+
'src/lib/**',
342+
'src/config/**',
343+
'src/hooks/**',
344+
'src/utils/**',
345+
'src/plugins/**',
346+
'src/specs/**',
347+
'src/client/**',
348+
'src/scss/**',
349+
'i18n/**',
350+
'*.config.js',
351+
'*.json',
352+
'*.lock',
353+
'README.md',
354+
'CONTRIBUTING.md',
355+
'gator_versioned_docs/**',
356+
],
357+
excludeImports: true,
358+
removeDuplicateHeadings: true,
359+
// Path transformation to fix URL construction
360+
// Since docsDir is '.', we need to remove 'docs/' prefix and handle src/pages paths
361+
pathTransformation: {
362+
ignorePaths: ['docs', 'src/pages'],
363+
},
364+
// Generate separate files for each section
365+
customLLMFiles: [
366+
{
367+
filename: 'llms-embedded-wallets.txt',
368+
includePatterns: ['embedded-wallets/**/*.{md,mdx}'],
369+
fullContent: false,
370+
title: 'MetaMask Embedded Wallets documentation',
371+
description: 'Documentation links for MetaMask Embedded Wallets',
372+
},
373+
{
374+
filename: 'llms-embedded-wallets-full.txt',
375+
includePatterns: ['embedded-wallets/**/*.{md,mdx}'],
376+
fullContent: true,
377+
title: 'MetaMask Embedded Wallets documentation',
378+
description: 'Complete documentation for MetaMask Embedded Wallets',
379+
},
380+
{
381+
filename: 'llms-sdk.txt',
382+
includePatterns: ['sdk/**/*.{md,mdx}'],
383+
fullContent: false,
384+
title: 'MetaMask SDK documentation',
385+
description: 'Documentation links for MetaMask SDK',
386+
},
387+
{
388+
filename: 'llms-sdk-full.txt',
389+
includePatterns: ['sdk/**/*.{md,mdx}'],
390+
fullContent: true,
391+
title: 'MetaMask SDK documentation',
392+
description: 'Complete documentation for MetaMask SDK',
393+
},
394+
{
395+
filename: 'llms-smart-accounts-kit.txt',
396+
includePatterns: ['smart-accounts-kit/**/*.{md,mdx}'],
397+
fullContent: false,
398+
title: 'MetaMask Smart Accounts Kit documentation',
399+
description: 'Documentation links for MetaMask Smart Accounts Kit',
400+
},
401+
{
402+
filename: 'llms-smart-accounts-kit-full.txt',
403+
includePatterns: ['smart-accounts-kit/**/*.{md,mdx}'],
404+
fullContent: true,
405+
title: 'MetaMask Smart Accounts Kit documentation',
406+
description: 'Complete documentation for MetaMask Smart Accounts Kit',
407+
},
408+
{
409+
filename: 'llms-snaps.txt',
410+
includePatterns: ['snaps/**/*.{md,mdx}'],
411+
fullContent: false,
412+
title: 'Snaps documentation',
413+
description: 'Documentation links for Snaps',
414+
},
415+
{
416+
filename: 'llms-snaps-full.txt',
417+
includePatterns: ['snaps/**/*.{md,mdx}'],
418+
fullContent: true,
419+
title: 'Snaps documentation',
420+
description: 'Complete documentation for Snaps',
421+
},
422+
{
423+
filename: 'llms-wallet.txt',
424+
includePatterns: ['wallet/**/*.{md,mdx}'],
425+
fullContent: false,
426+
title: 'Wallet API documentation',
427+
description: 'Documentation links for Wallet API',
428+
},
429+
{
430+
filename: 'llms-wallet-full.txt',
431+
includePatterns: ['wallet/**/*.{md,mdx}'],
432+
fullContent: true,
433+
title: 'Wallet API documentation',
434+
description: 'Complete documentation for Wallet API',
435+
},
436+
{
437+
filename: 'llms-tutorials.txt',
438+
includePatterns: ['src/pages/tutorials/**/*.{md,mdx}'],
439+
fullContent: false,
440+
title: 'Tutorials',
441+
description: 'Documentation links for MetaMask tutorials',
442+
},
443+
{
444+
filename: 'llms-tutorials-full.txt',
445+
includePatterns: ['src/pages/tutorials/**/*.{md,mdx}'],
446+
fullContent: true,
447+
title: 'Tutorials',
448+
description: 'Complete documentation for MetaMask tutorials',
449+
},
450+
{
451+
filename: 'llms-dashboard.txt',
452+
includePatterns: ['developer-tools/dashboard/**/*.{md,mdx}'],
453+
fullContent: false,
454+
title: 'Developer dashboard documentation',
455+
description: 'Documentation links for MetaMask Developer dashboard',
456+
},
457+
{
458+
filename: 'llms-dashboard-full.txt',
459+
includePatterns: ['developer-tools/dashboard/**/*.{md,mdx}'],
460+
fullContent: true,
461+
title: 'Developer dashboard documentation',
462+
description: 'Complete documentation for MetaMask Developer dashboard',
463+
},
464+
{
465+
filename: 'llms-services.txt',
466+
includePatterns: ['services/**/*.md'],
467+
fullContent: false,
468+
title: 'Services documentation',
469+
description: 'Documentation links for MetaMask services',
470+
},
471+
{
472+
filename: 'llms-services-full.txt',
473+
includePatterns: ['services/**/*.md'],
474+
fullContent: true,
475+
title: 'Services documentation',
476+
description: 'Complete documentation for MetaMask services',
477+
},
478+
],
479+
},
480+
],
320481
],
321482
clientModules: [require.resolve('./src/client/scroll-fix.js')],
322483
themeConfig:

embedded-wallets/connect-blockchain/solana/javascript.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,13 +279,13 @@ console.log(result.toString())
279279

280280
## Fetch User's Private Key
281281

282-
`solanaPrivateKey` is used to fetch the private key of the logged in user. It is only available for `in-app` adapters like `auth`.
282+
`solana_privateKey` is used to fetch the private key of the logged in user. It is only available for `in-app` adapters like `auth`.
283283

284284
```tsx
285285
// Assuming user is already logged in.
286286
async getPrivateKey() {
287287
const privateKey = await web3auth.provider.request({
288-
method: "solanaPrivateKey"
288+
method: "solana_privateKey"
289289
});
290290

291291
// Do something with privateKey

embedded-wallets/sdk/js/_solana-integration-snippets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,13 +218,13 @@ console.log(result.toString())
218218

219219
## Fetch User's Private Key
220220

221-
`solanaPrivateKey` is used to fetch the private key of the logged in user. It is only available for `in-app` adapters like `auth`.
221+
`solana_privateKey` is used to fetch the private key of the logged in user. It is only available for `in-app` adapters like `auth`.
222222

223223
```tsx
224224
// Assuming user is already logged in.
225225
async getPrivateKey() {
226226
const privateKey = await web3auth.provider.request({
227-
method: "solanaPrivateKey"
227+
method: "solana_privateKey"
228228
});
229229

230230
// Do something with privateKey

0 commit comments

Comments
 (0)