Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
0b79037
SDK new structure PoC
alexandratran Sep 23, 2025
44a6248
edits
alexandratran Sep 24, 2025
f234baf
remove custom reference component
alexandratran Sep 24, 2025
f331654
edits
alexandratran Sep 25, 2025
e2f4b8b
Merge branch 'main' into sdk-new-structure
alexandratran Sep 30, 2025
ef20ee1
fix links, update redirects, "metamask wallet sdk"
alexandratran Sep 30, 2025
39b9b16
Merge branch 'main' into sdk-new-structure
alexandratran Oct 16, 2025
905d9a8
add simplified api reference with two examples
alexandratran Oct 18, 2025
549887c
missing files
alexandratran Oct 18, 2025
1b97b2c
Merge branch 'main' into sdk-new-structure
alexandratran Oct 20, 2025
bb103fb
remove starknet docs
alexandratran Oct 21, 2025
8216d8b
copy over solana docs
alexandratran Oct 21, 2025
34aed2c
Merge branch 'main' into sdk-new-structure
alexandratran Oct 22, 2025
d64e8a4
Merge branch 'main' into sdk-new-structure
alexandratran Oct 23, 2025
e02092a
Update terminology and restructure EVM docs
alexandratran Oct 23, 2025
956c09a
fix broken links
alexandratran Oct 23, 2025
86d2dfc
Merge branch 'main' into sdk-new-structure
alexandratran Nov 4, 2025
f70f940
fix broken links
alexandratran Nov 4, 2025
e1e0008
Add/update Solana Wallet Adapter docs (#2443)
alexandratran Nov 7, 2025
37a4d06
Merge branch 'main' into sdk-new-structure
alexandratran Nov 10, 2025
30d0439
Update mobile products menu
alexandratran Nov 10, 2025
3db005f
Update MM Connect EVM JS code samples with potential new usage (#2454)
alexandratran Nov 12, 2025
d122361
Merge branch 'main' into sdk-new-structure
alexandratran Nov 13, 2025
360383d
Remove ParserOpenRPC component and replace usage in Linea services
alexandratran Nov 14, 2025
98476fe
Merge branch 'main' into sdk-new-structure
alexandratran Nov 18, 2025
c04fb6d
fix broken link
alexandratran Nov 18, 2025
b034e01
Add more multichain info (#2479)
alexandratran Nov 18, 2025
77bb9a9
Merge branch 'main' into sdk-new-structure
alexandratran Nov 27, 2025
b4716d6
Enhance JS section {WIP} (#2450)
shahbaz17 Nov 27, 2025
2a6e4ab
Add view & wagmi options
shahbaz17 Nov 27, 2025
6cf2880
Merge branch 'main' into sdk-new-structure
alexandratran Nov 28, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'main' into sdk-new-structure
# Conflicts:
#	wallet/concepts/wallet-interoperability.md
#	wallet/how-to/connect-extension.md
  • Loading branch information
alexandratran committed Nov 27, 2025
commit 77bb9a986ae95e09f88e66b820f50339c9214ef0
10 changes: 5 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Build
uses: ConsenSys/github-actions/docs-build@main

Expand All @@ -30,7 +30,7 @@ jobs:
matrix:
folder: ['docs']
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Case check action
uses: ConsenSys/github-actions/docs-case-check@main
with:
Expand All @@ -41,7 +41,7 @@ jobs:
name: Lint Code Base
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Lint
uses: ConsenSys/github-actions/docs-lint-all@main

Expand All @@ -52,7 +52,7 @@ jobs:
matrix:
file-extensions: ['.md', '.mdx']
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Vale
uses: Consensys/github-actions/docs-spelling-check@main
with:
Expand All @@ -62,7 +62,7 @@ jobs:
name: Link Checking
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: LinkCheck
uses: ConsenSys/github-actions/docs-link-check@main
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/crowdin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Synchronize with Crowdin
uses: crowdin/github-action@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/dependency_review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
permissions:
contents: read
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6

- name: Dependency review
uses: ConsenSys/github-actions/js-dependency-review@main
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
permissions:
contents: read
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: LinkCheck mdx files
uses: ConsenSys/github-actions/docs-link-check@main
with:
Expand All @@ -32,7 +32,7 @@
permissions:
contents: read
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: LinkCheck md files
uses: ConsenSys/github-actions/docs-link-check@main
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/security-code-scanner.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
contents: read
security-events: write
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: MetaMask Security Code Scanner
uses: ConsenSys/github-actions/mm-security-scanner@main
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/trivy-cache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ jobs:
name: Run trivy scanner
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Trivy Cache
uses: ConsenSys/github-actions/trivy-update-cache@main
2 changes: 1 addition & 1 deletion .github/workflows/trivy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
name: Run trivy scanner
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: actions/checkout@v6
- name: Trivy
uses: ConsenSys/github-actions/trivy@main
with:
Expand Down
2 changes: 2 additions & 0 deletions .linkspector.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ ignorePatterns:
- pattern: '^/snaps/'
- pattern: '^/wallet/'
- pattern: '^/tutorials/'
- pattern: 'https://web3onboard.thirdweb.com'
- pattern: 'https://0xfury.com/privacy'
aliveStatusCodes:
- 200
- 206
Expand Down
41 changes: 35 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ guide in some places.
- [Contribution workflow](#contribution-workflow)
- [Preview locally](#preview-locally)
- [Style guide](#style-guide)
- [Format links](#format-links)
- [Add images](#add-images)
- [Test analytics](#test-analytics)

Expand Down Expand Up @@ -68,10 +69,10 @@ To contribute changes:

> **Notes:**
>
> - All documentation content is located in the `wallet`, `sdk`, `snaps`, `services`, and
> `developer-tools` directories.
> - If you add a new documentation page, edit `wallet-sidebar.js`, `sdk-sidebar.js`, `snaps-sidebar.js`,
> `services-sidebar.js`, or `dashboard-sidebar.js` to add the page to the
> - All documentation content is located in the `sdk`, `wallet`, `embedded-wallets`, `smart-accounts-kit`, `services`,
> `developer-tools`, `snaps`, and `src/pages` directories.
> - If you add a new documentation page, edit `sdk-sidebar.js`, `wallet-sidebar.js`, `ew-sidebar.js`, `gator-sidebar.js`,
> `services-sidebar.js`, `dashboard-sidebar.js`, or `snaps-sidebar.js` to add the page to the
> [sidebar](https://docs-template.consensys.io/create/configure-docusaurus#sidebar).
> - If you delete, rename, or move a documentation file, add a
> [redirect](https://vercel.com/docs/edge-network/redirects#configuration-redirects).
Expand Down Expand Up @@ -113,10 +114,38 @@ To contribute changes:

Refer to the [Consensys documentation style guide](https://docs-template.consensys.net/contribute/style-guide).

## Format links

Most links in the Markdown pages use *relative file paths*, for example:

```md
You can enable users to create a [MetaMask smart account](../../concepts/smart-accounts.md) directly in your dapp.
```

However, when linking between different product sections or using the `CardList` component, use *absolute URL paths*. For example:

```md
When a dapp requests to submit a batch of transactions atomically, MetaMask may prompt users to upgrade their
externally owned account (EOA) to a [MetaMask smart account](/smart-accounts-kit/concepts/smart-accounts).
```

```md
<CardList
items={[
{
href: '/snaps/learn/about-snaps',
title: 'About Snaps',
description: 'See a high-level, technical overview of the Snaps system.',
},
...
]}
/>
```

## Add images

All images are located in the `wallet/assets`, `sdk/_assets`, `snaps/assets`, `services/images`, and
`developer-tools/images` directories.
All images are located in the `sdk/_assets`, `wallet/assets`, `smart-accounts-kit/assets`, `services/images`,
`developer-tools/images`, `snaps/assets`, and `static/img` directories.
When adding a new image, such as a screenshot or diagram, make sure the image has a white or
`#1b1b1d` color background in order for it to be compatible with the site's light and dark modes.

Expand Down
6 changes: 3 additions & 3 deletions developer-tools/dashboard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ Select one of the cards below to learn more about using the dashboard.
<CardList
items={[
{
href: "./get-started/create-api",
href: "/developer-tools/dashboard/get-started/create-api",
title: "Create an API key",
description: "Learn how to create an API key that allows you to make API calls."
},
{
href: "./how-to/secure-an-api/api-key",
href: "/developer-tools/dashboard/how-to/secure-an-api/api-key",
title: "Secure your API key",
description: "Learn how to secure your API key to avoid unwanted costs and unauthorized access."
},
{
href: "./how-to/dashboard-stats",
href: "/developer-tools/dashboard/how-to/dashboard-stats",
title: "Monitor API call stats",
description: "Learn how to use the dashboard to view API call stats."
}
Expand Down
161 changes: 161 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ const config = {
SENTRY_KEY: process.env.SENTRY_KEY,
LINEA_ENS_URL: process.env.LINEA_ENS_URL,
SEGMENT_ANALYTICS_KEY: process.env.SEGMENT_ANALYTICS_KEY,
DISCOURSE_API_KEY: process.env.DISCOURSE_API_KEY,
DISCOURSE_API_USERNAME: process.env.DISCOURSE_API_USERNAME,
DISCOURSE_CATEGORY_ID: process.env.DISCOURSE_CATEGORY_ID,
},

trailingSlash: true,
Expand Down Expand Up @@ -286,6 +289,164 @@ const config = {
containerId: 'GTM-5FGPLC2Q',
},
],
[
'docusaurus-plugin-llms',
{
// Set docsDir to site root to collect from all directories
docsDir: '.',
// Disable default files since we're generating section-specific files
generateLLMsTxt: false,
generateLLMsFullTxt: false,
// Ignore common non-doc directories
// Note: src/pages/** is not ignored so tutorials can be collected
// Each customLLMFiles entry filters by includePatterns, so only matching files are included
ignoreFiles: [
'node_modules/**',
'build/**',
'.docusaurus/**',
'static/**',
'src/components/**',
'src/theme/**',
'src/lib/**',
'src/config/**',
'src/hooks/**',
'src/utils/**',
'src/plugins/**',
'src/specs/**',
'src/client/**',
'src/scss/**',
'i18n/**',
'*.config.js',
'*.json',
'*.lock',
'README.md',
'CONTRIBUTING.md',
'gator_versioned_docs/**',
],
excludeImports: true,
removeDuplicateHeadings: true,
// Path transformation to fix URL construction
// Since docsDir is '.', we need to remove 'docs/' prefix and handle src/pages paths
pathTransformation: {
ignorePaths: ['docs', 'src/pages'],
},
// Generate separate files for each section
customLLMFiles: [
{
filename: 'llms-embedded-wallets.txt',
includePatterns: ['embedded-wallets/**/*.{md,mdx}'],
fullContent: false,
title: 'MetaMask Embedded Wallets documentation',
description: 'Documentation links for MetaMask Embedded Wallets',
},
{
filename: 'llms-embedded-wallets-full.txt',
includePatterns: ['embedded-wallets/**/*.{md,mdx}'],
fullContent: true,
title: 'MetaMask Embedded Wallets documentation',
description: 'Complete documentation for MetaMask Embedded Wallets',
},
{
filename: 'llms-sdk.txt',
includePatterns: ['sdk/**/*.{md,mdx}'],
fullContent: false,
title: 'MetaMask SDK documentation',
description: 'Documentation links for MetaMask SDK',
},
{
filename: 'llms-sdk-full.txt',
includePatterns: ['sdk/**/*.{md,mdx}'],
fullContent: true,
title: 'MetaMask SDK documentation',
description: 'Complete documentation for MetaMask SDK',
},
{
filename: 'llms-smart-accounts-kit.txt',
includePatterns: ['smart-accounts-kit/**/*.{md,mdx}'],
fullContent: false,
title: 'MetaMask Smart Accounts Kit documentation',
description: 'Documentation links for MetaMask Smart Accounts Kit',
},
{
filename: 'llms-smart-accounts-kit-full.txt',
includePatterns: ['smart-accounts-kit/**/*.{md,mdx}'],
fullContent: true,
title: 'MetaMask Smart Accounts Kit documentation',
description: 'Complete documentation for MetaMask Smart Accounts Kit',
},
{
filename: 'llms-snaps.txt',
includePatterns: ['snaps/**/*.{md,mdx}'],
fullContent: false,
title: 'Snaps documentation',
description: 'Documentation links for Snaps',
},
{
filename: 'llms-snaps-full.txt',
includePatterns: ['snaps/**/*.{md,mdx}'],
fullContent: true,
title: 'Snaps documentation',
description: 'Complete documentation for Snaps',
},
{
filename: 'llms-wallet.txt',
includePatterns: ['wallet/**/*.{md,mdx}'],
fullContent: false,
title: 'Wallet API documentation',
description: 'Documentation links for Wallet API',
},
{
filename: 'llms-wallet-full.txt',
includePatterns: ['wallet/**/*.{md,mdx}'],
fullContent: true,
title: 'Wallet API documentation',
description: 'Complete documentation for Wallet API',
},
{
filename: 'llms-tutorials.txt',
includePatterns: ['src/pages/tutorials/**/*.{md,mdx}'],
fullContent: false,
title: 'Tutorials',
description: 'Documentation links for MetaMask tutorials',
},
{
filename: 'llms-tutorials-full.txt',
includePatterns: ['src/pages/tutorials/**/*.{md,mdx}'],
fullContent: true,
title: 'Tutorials',
description: 'Complete documentation for MetaMask tutorials',
},
{
filename: 'llms-dashboard.txt',
includePatterns: ['developer-tools/dashboard/**/*.{md,mdx}'],
fullContent: false,
title: 'Developer dashboard documentation',
description: 'Documentation links for MetaMask Developer dashboard',
},
{
filename: 'llms-dashboard-full.txt',
includePatterns: ['developer-tools/dashboard/**/*.{md,mdx}'],
fullContent: true,
title: 'Developer dashboard documentation',
description: 'Complete documentation for MetaMask Developer dashboard',
},
{
filename: 'llms-services.txt',
includePatterns: ['services/**/*.{md,mdx}'],
fullContent: false,
title: 'Services documentation',
description: 'Documentation links for MetaMask services',
},
{
filename: 'llms-services-full.txt',
includePatterns: ['services/**/*.{md,mdx}'],
fullContent: true,
title: 'Services documentation',
description: 'Complete documentation for MetaMask services',
},
],
},
],
],
clientModules: [require.resolve('./src/client/scroll-fix.js')],
themeConfig:
Expand Down
Loading
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.