Skip to content
This repository was archived by the owner on Jan 5, 2024. It is now read-only.

Commit 95a4ea3

Browse files
joaquim-vergesjoaquim-verges
committed
Update docs
1 parent cef5fe1 commit 95a4ea3

12 files changed

+231
-141
lines changed

‎docs/example-repos.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -429,15 +429,15 @@
429429
"html_url": "https://github.com/thirdweb-example/nft-staking-app",
430430
"description": "An NFT Staking contract deployed using thirdweb deploy, where users stake their ERC721 tokens and earn ERC20 tokens in return!",
431431
"created_at": "2022-05-31T05:09:19Z",
432-
"updated_at": "2022-08-28T18:47:21Z",
432+
"updated_at": "2022-08-29T16:28:01Z",
433433
"clone_url": "https://github.com/thirdweb-example/nft-staking-app.git",
434434
"topics": [
435435
"nft-drop",
436436
"thirdweb-deploy",
437437
"token"
438438
],
439439
"language": "TypeScript",
440-
"stargazers_count": 34,
440+
"stargazers_count": 33,
441441
"is_template": false,
442442
"homepage": "https://nft-staking-contract.thirdweb-example.com/"
443443
},

‎docs/python/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ displayed_sidebar: python
1616
<a href="https://discord.gg/thirdweb"><img alt="Join our Discord!" src="https://img.shields.io/discord/834227967404146718.svg?color=7289da&label=discord&logo=discord&style=flat"/></a>
1717

1818
</p>
19-
<p align="center"><strong>Best in class SDK for Python 3.7+</strong></p>
19+
<p align="center"><strong>Best in class Web3 SDK for Python 3.7+</strong></p>
2020
<br />
2121

2222
## Installation

‎docs/react/react.connectwallet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ const App = () => {
3232
**Signature:**
3333

3434
```typescript
35-
ConnectWallet: React.FC<ConnectWalletProps>
35+
ConnectWallet: React.FC<ConnectWalletProps>;
3636
```

‎docs/react/react.mediarenderer.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ You can try switching out the `src` prop to different types of URLs and media ty
3333
**Signature:**
3434

3535
```typescript
36-
MediaRenderer: React.ForwardRefExoticComponent<MediaRendererProps & {
36+
MediaRenderer: React.ForwardRefExoticComponent<
37+
MediaRendererProps & {
3738
children?: React.ReactNode;
38-
} & React.RefAttributes<HTMLMediaElement>>
39+
} & React.RefAttributes<HTMLMediaElement>
40+
>;
3941
```

‎docs/react/react.thirdwebnftmedia.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,7 @@ Use this to get the primary sales recipient of your
3636
**Signature:**
3737

3838
```typescript
39-
ThirdwebNftMedia: React.ForwardRefExoticComponent<ThirdwebNftMediaProps & React.RefAttributes<HTMLMediaElement>>
39+
ThirdwebNftMedia: React.ForwardRefExoticComponent<
40+
ThirdwebNftMediaProps & React.RefAttributes<HTMLMediaElement>
41+
>;
4042
```

‎docs/react/react.thirdwebsdkprovider.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ You can use this in order to be able to pass a provider &amp; signer directly to
1818
**Signature:**
1919

2020
```typescript
21-
ThirdwebSDKProvider: React.FC<React.PropsWithChildren<ThirdwebSDKProviderProps>>
21+
ThirdwebSDKProvider: React.FC<
22+
React.PropsWithChildren<ThirdwebSDKProviderProps>
23+
>;
2224
```
2325

2426
## Remarks

‎docs/typescript/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ displayed_sidebar: typescript
1616
<a href="https://discord.gg/thirdweb"><img alt="Join our Discord!" src="https://img.shields.io/discord/834227967404146718.svg?color=7289da&label=discord&logo=discord&style=flat"/></a>
1717

1818
</p>
19-
<p align="center"><strong>Best in class SDK for Browser, Node and Mobile apps</strong></p>
19+
<p align="center"><strong>Best in class Web3 SDK for Browser, Node and Mobile apps</strong></p>
2020
<br />
2121

2222
## Installation
@@ -84,7 +84,7 @@ Here's how to provide your own private key to the SDK to perform transactions wi
8484
// my_script.js
8585
import { ThirdwebSDK } from "@thirdweb-dev/sdk";
8686

87-
// Learn more about securely accessing your private key: https://portal.thirdweb.com/sdk/set-up-the-sdk/securing-your-private-key
87+
// Learn more about securely accessing your private key: https://portal.thirdweb.com/web3-sdk/set-up-the-sdk/securing-your-private-key
8888
const privateKey = "<your-private-key-here>";
8989
// instantiate the SDK based on your private key, with the desired chain to connect to
9090
const sdk = ThirdwebSDK.fromPrivateKey(privateKey, "polygon");

‎docs/typescript/sdk.marketplace.roles.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,8 @@ displayed_sidebar: typescript
1212
**Signature:**
1313

1414
```typescript
15-
roles: ContractRoles<MarketplaceContract, typeof Marketplace.contractRoles[number]>;
15+
roles: ContractRoles<
16+
MarketplaceContract,
17+
typeof Marketplace.contractRoles[number]
18+
>;
1619
```

‎docs/typescript/sdk.native_tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ displayed_sidebar: typescript
1212
**Signature:**
1313

1414
```typescript
15-
NATIVE_TOKENS: Record<SUPPORTED_CHAIN_ID | ChainId.Hardhat, NativeToken>
15+
NATIVE_TOKENS: Record<SUPPORTED_CHAIN_ID | ChainId.Hardhat, NativeToken>;
1616
```

‎docs/typescript/sdk.profileschemaoutput.md

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,31 @@ displayed_sidebar: typescript
1212
**Signature:**
1313

1414
```typescript
15-
ProfileSchemaOutput: z.ZodObject<z.extendShape<{
16-
name: z.ZodOptional<z.ZodString>;
17-
bio: z.ZodOptional<z.ZodString>;
18-
avatar: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodTypeAny, z.ZodString]>>>;
19-
website: z.ZodOptional<z.ZodString>;
20-
twitter: z.ZodOptional<z.ZodString>;
21-
telegram: z.ZodOptional<z.ZodString>;
22-
facebook: z.ZodOptional<z.ZodString>;
23-
github: z.ZodOptional<z.ZodString>;
24-
medium: z.ZodOptional<z.ZodString>;
25-
linkedin: z.ZodOptional<z.ZodString>;
26-
reddit: z.ZodOptional<z.ZodString>;
27-
discord: z.ZodOptional<z.ZodString>;
28-
}, {
29-
avatar: z.ZodOptional<z.ZodNullable<z.ZodString>>;
30-
}>, "strip", z.ZodTypeAny, {
15+
ProfileSchemaOutput: z.ZodObject<
16+
z.extendShape<
17+
{
18+
name: z.ZodOptional<z.ZodString>;
19+
bio: z.ZodOptional<z.ZodString>;
20+
avatar: z.ZodOptional<
21+
z.ZodNullable<z.ZodUnion<[z.ZodTypeAny, z.ZodString]>>
22+
>;
23+
website: z.ZodOptional<z.ZodString>;
24+
twitter: z.ZodOptional<z.ZodString>;
25+
telegram: z.ZodOptional<z.ZodString>;
26+
facebook: z.ZodOptional<z.ZodString>;
27+
github: z.ZodOptional<z.ZodString>;
28+
medium: z.ZodOptional<z.ZodString>;
29+
linkedin: z.ZodOptional<z.ZodString>;
30+
reddit: z.ZodOptional<z.ZodString>;
31+
discord: z.ZodOptional<z.ZodString>;
32+
},
33+
{
34+
avatar: z.ZodOptional<z.ZodNullable<z.ZodString>>;
35+
}
36+
>,
37+
"strip",
38+
z.ZodTypeAny,
39+
{
3140
name?: string | undefined;
3241
bio?: string | undefined;
3342
avatar?: string | null | undefined;
@@ -40,7 +49,8 @@ ProfileSchemaOutput: z.ZodObject<z.extendShape<{
4049
linkedin?: string | undefined;
4150
reddit?: string | undefined;
4251
discord?: string | undefined;
43-
}, {
52+
},
53+
{
4454
name?: string | undefined;
4555
bio?: string | undefined;
4656
avatar?: string | null | undefined;
@@ -53,5 +63,6 @@ ProfileSchemaOutput: z.ZodObject<z.extendShape<{
5363
linkedin?: string | undefined;
5464
reddit?: string | undefined;
5565
discord?: string | undefined;
56-
}>
66+
}
67+
>;
5768
```

0 commit comments

Comments
 (0)