Skip to content

Commit f7c521c

Browse files
yashovardhanbgravenorstalexandratranshahbaz17ihsraham
authored
New flow of documentation (#2179)
* add base IB from W3A docs * fixes * Further fixes * Add highlighting and blur magic comments * fix css issues * Fix scrolling * Add MM SDK & DTK products in quick start * Fix CSS issues * Update pane * quick-start -> playground * Update home page * Update nav bar * add base IB from W3A docs * fixes * Further fixes * Add highlighting and blur magic comments * fix css issues * Fix scrolling * Add MM SDK & DTK products in quick start * Fix CSS issues * Update pane * quick-start -> playground * Update home page * Update nav bar * Fix build * Fix build issues * Fix highlighting error * Remove DTK from builder * Add overlay on builder * Update NavigationFlow.tsx * Update builder UI * fix css issues * playground -> quickstart * Update QS * Update react qs * update map filenames * temp * Add guides component * Add SidebarSectionDropdown component and update sidebar rendering * Fix formatting. Signed-off-by: bgravenorst <[email protected]> * guides -> tutorials * Quick start -> Quickstart Signed-off-by: bgravenorst <[email protected]> * Remove product banner. Signed-off-by: bgravenorst <[email protected]> * Add product banner and dropdown desc. Signed-off-by: bgravenorst <[email protected]> * Fix dropdown descriptions. Signed-off-by: bgravenorst <[email protected]> * clean up styles and labels * Add MetaMask SDK React Quickstart * Update package.json * build fixes * Fix lint issues * Update docusaurus.config.js * Fix build issues * fix linting issues * updated links * minor fixes * Update card description. Signed-off-by: bgravenorst <[email protected]> * Add bullet point and code styling. Signed-off-by: bgravenorst <[email protected]> * fix breaking card links, remove what's new content, and fix quickstart card styles * update dtk quickstart links * W3a docs (#2255) * wip * update examples * Add embedded wallets intro page * Fix issues * Add sub nav bar * Update sidebarsectiondropdown styling * restructure ew docs * Fix troubleshooting sidebar * Update links in guides * Fix CI build error. Signed-off-by: bgravenorst <[email protected]> * restructure dashboard section * fix linting issues * Update naming conventions * Update features section * Fix build issues * updates * fixes * migration guides restructure * update flutter documentation * Structure update for unreal, unity & ios * Updated Connect Blockchain section * Removed unused files * edited troubleshooting docs * Web3Auth references to EW in authentication Updated documentation to replace 'Web3Auth' with 'Embedded Wallets' throughout authentication and troubleshooting guides. Adjusted dashboard references, titles, descriptions, and internal links to reflect the new branding and clarify SDK naming conventions. * react native structure update * Update content for SDKs * Update react native content --------- Signed-off-by: bgravenorst <[email protected]> Co-authored-by: Yashovardhan Agrawal <[email protected]> Co-authored-by: bgravenorst <[email protected]> Co-authored-by: Maharshi Mishra <[email protected]> * Fix qs builder issues * Fix tutorials issues * Update EW builder content * Add missing css causing transparent subnavbar. Signed-off-by: bgravenorst <[email protected]> * Update tutorials * Update banners * Fix broken links * Fix more broken links * Update fix-trailing-slash.js * Update NavigationOverlay.module.css * shift dtk tutorials * fix broken links * fix linting issue * fix more broken links * Fix prettier issues * fix linting issues * fix more broken links * tsc fix * Fix tsc issue * add author --------- Signed-off-by: bgravenorst <[email protected]> Co-authored-by: Yashovardhan Agrawal <[email protected]> Co-authored-by: bgravenorst <[email protected]> Co-authored-by: Alexandra Tran <[email protected]> Co-authored-by: Mohammad Shahbaz Alam <[email protected]> Co-authored-by: Maharshi Mishra <[email protected]>
1 parent e68e3c6 commit f7c521c

File tree

1,395 files changed

+121941
-22125
lines changed

Some content is hidden

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

1,395 files changed

+121941
-22125
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,3 @@ Fixes #
1111
## Preview
1212

1313
<!-- Provide a PR preview link to the page(s) changed. -->
14-
15-
## Checklist
16-
17-
Complete this checklist before merging your PR:
18-
19-
- [ ] 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.
20-
- [ ] The proposed changes have been reviewed and approved by a member of the documentation team.

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@
2121
npm-debug.log*
2222
.vercel
2323
.envrc
24-
.env
24+
.env
25+
.integrationBuilderCache

‎CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,6 @@ To contribute changes:
7979
> - If you delete, rename, or move a documentation file, add a
8080
> [redirect](https://vercel.com/docs/edge-network/redirects#configuration-redirects).
8181
> - See additional instructions for [updating the interactive API reference](#update-the-interactive-api-reference).
82-
> - If the PR contains a major change to the documentation content, add an entry to the top of
83-
> the ["What's new?"](docs/whats-new.md) page.
8482
8583
5. [Preview your changes locally](https://docs-template.consensys.net/contribute/preview) to check
8684
that the changes render correctly.

‎delegation-toolkit/concepts/delegation/caveat-enforcers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ for common restriction patterns, including:
160160
- Restricting token transfers and approvals.
161161
- Limiting execution frequency.
162162

163-
For other restriction patterns, you can also [create custom caveat enforcers](../../tutorials/create-custom-caveat-enforcer.md) by implementing the `ICaveatEnforcer` interface.
163+
For other restriction patterns, you can also [create custom caveat enforcers](/tutorials/create-custom-caveat-enforcer) by implementing the `ICaveatEnforcer` interface.
164164

165165
## Attenuating authority with redelegations
166166

‎delegation-toolkit/get-started/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This page provides instructions to install and set up the MetaMask Delegation To
1717
- Install [Yarn](https://yarnpkg.com/),
1818
[npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), or another package manager.
1919
- If you plan to use any smart contracts (for example, to
20-
[create a custom caveat enforcer](../tutorials/create-custom-caveat-enforcer.md)),
20+
[create a custom caveat enforcer](/tutorials/create-custom-caveat-enforcer)),
2121
install [Foundry](https://book.getfoundry.sh/getting-started/installation).
2222

2323
## Steps
@@ -33,7 +33,7 @@ npm install @metamask/delegation-toolkit
3333
### 2. (Optional) Install the contracts
3434

3535
If you plan to extend the Delegation Framework smart contracts (for example, to
36-
[create a custom caveat enforcer](../tutorials/create-custom-caveat-enforcer.md)), install
36+
[create a custom caveat enforcer](/tutorials/create-custom-caveat-enforcer)), install
3737
the contract package using Foundry's command-line tool, Forge:
3838

3939
```bash

‎delegation-toolkit/get-started/smart-account-quickstart/eip7702.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,4 @@ const userOperationHash = await bundlerClient.sendUserOperation({
158158

159159
- To grant specific permissions to other accounts from your smart account, [create a delegation](../../guides/delegation/execute-on-smart-accounts-behalf.md).
160160
- To quickly bootstrap a MetaMask Smart Accounts project, [use the CLI](../use-the-cli.md).
161-
- You can also [use MetaMask SDK to upgrade a MetaMask account to a smart account](/sdk/tutorials/upgrade-eoa-to-smart-account).
161+
- You can also [use MetaMask SDK to upgrade a MetaMask account to a smart account](/tutorials/upgrade-eoa-to-smart-account).

‎delegation-toolkit/guides/delegation/restrict-delegation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,5 @@ const delegation = createDelegation({
105105
});
106106
```
107107

108-
For more specific or custom control, you can also [create custom caveat enforcers](../../tutorials/create-custom-caveat-enforcer.md)
108+
For more specific or custom control, you can also [create custom caveat enforcers](/tutorials/create-custom-caveat-enforcer)
109109
and add them to the caveat builder.

‎delegation-toolkit/reference/api/experimental-actions/bundler-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Objects in the `calls` array also require the following parameters:
3131
| Name | Type | Required | Description |
3232
| ---- | ---- | -------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3333
| `delegationManager` | `0x${string}` | Yes | The address of Delegation Manager. |
34-
| `permissionsContext` | `0x${string}` | Yes | Encoded calldata for redeeming delegations. If you're not using ERC-7715, you can use the [`redeemDelegation`](../delegation.md#redeemdelegation) utility function to generate the calldata manually. |
34+
| `permissionsContext` | `0x${string}` | Yes | Encoded calldata for redeeming delegations. If you're not using ERC-7715, you can use the [`redeemDelegations`](../delegation.md#redeemdelegations) utility function to generate the calldata manually. |
3535

3636
### Example
3737

‎delegation-toolkit/reference/api/experimental-actions/wallet-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ This function has the same parameters, and it also requires the following parame
101101
| Name | Type | Required | Description |
102102
| ---- | ---- | -------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
103103
| `delegationManager` | `0x${string}` | Yes | The address of the Delegation Manager. |
104-
| `permissionsContext` | `0x${string}` | Yes | Encoded calldata for redeeming delegations. If you're not using ERC-7715, you can use the [`redeemDelegation`](../delegation.md#redeemdelegation) utility function to generate the calldata manually. |
104+
| `permissionsContext` | `0x${string}` | Yes | Encoded calldata for redeeming delegations. If you're not using ERC-7715, you can use the [`redeemDelegations`](../delegation.md#redeemdelegations) utility function to generate the calldata manually. |
105105

106106
### Example
107107

‎delegation-toolkit/tutorials/_category_.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)