Nextra V3 (#88)

* chore: upgrade to nextra v3

* use npm2yarn

* code example filename

* ignore .next

* update pnpm

* remove changelog page

* update seo

* upgrade

.prettierignore

@@ -2,3 +2,4 @@
 coverage/
 .pnp.*
 pnpm-lock.yaml
+.next/

next.config.mjs

@@ -1,11 +1,12 @@
+// @ts-check
 import nextra from 'nextra'
 
 const withNextra = nextra({
   theme: 'nextra-theme-docs',
   themeConfig: './theme.config.js',
-  unstable_staticImage: true,
-  unstable_flexsearch: {
-    codeblock: false,
+  staticImage: true,
+  search: {
+    codeblocks: false,
   },
   defaultShowCopyCode: true,
 })

package.json

@@ -21,17 +21,17 @@
   },
   "homepage": "https://github.com/soundxyz/docs#readme",
   "engines": {
-    "pnpm": ">=7.9.1"
+    "pnpm": ">=8.10.5"
   },
-  "packageManager": "pnpm@7.18.2",
+  "packageManager": "pnpm@8.10.5",
   "devDependencies": {
     "@geist-ui/react-icons": "^1.0.1",
     "@types/node": "18.16.1",
     "autoprefixer": "^10.4.14",
     "husky": "^8.0.3",
-    "next": "^13.2.4",
-    "nextra": "2.3.0",
-    "nextra-theme-docs": "2.3.0",
+    "next": "^13.5.6",
+    "nextra": "3.0.0-alpha.12",
+    "nextra-theme-docs": "3.0.0-alpha.12",
     "postcss": "^8.4.21",
     "prettier": "^2.8.8",
     "pretty-quick": "^3.1.3",

pages/_meta.ts

@@ -0,0 +1,28 @@
+export default {
+  index: {
+    display: 'hidden',
+    hidden: true,
+    theme: {
+      sidebar: false,
+      layout: 'raw',
+    },
+  },
+  intro: {
+    title: 'Sound Docs',
+  },
+  protocol: {
+    title: 'Sound Protocol',
+  },
+  sdk: {
+    title: 'Sound SDK',
+  },
+  'sound-api': {
+    title: 'Sound API',
+  },
+  'api-explorer': {
+    title: 'API Explorer',
+    theme: {
+      layout: 'raw',
+    },
+  },
+}

pages/protocol/_meta.ts

@@ -0,0 +1,6 @@
+export default {
+  overview: 'Overview',
+  core: 'Core Contracts',
+  modules: 'Module Contracts',
+  libraries: 'Libraries',
+}

pages/protocol/core/_meta.ts

@@ -0,0 +1,6 @@
+export default {
+  'sound-creator-v1': 'SoundCreatorV1',
+  'sound-edition': 'SoundEdition',
+  'i-minter-module': 'IMinterModule',
+  'i-metadata-module': 'IMetadataModule',
+}

pages/protocol/modules/_meta.ts

@@ -0,0 +1,4 @@
+export default {
+  metadata: 'Metadata',
+  minters: 'Minters',
+}

pages/protocol/modules/metadata/_meta.ts

@@ -0,0 +1,3 @@
+export default {
+  'golden-egg-metadata': 'GoldenEgg Metadata',
+}

pages/protocol/modules/minters/_meta.ts

@@ -0,0 +1,6 @@
+export default {
+  'edition-max-minter': 'EditionMaxMinter',
+  'range-edition-minter': 'RangeEditionMinter',
+  'fixed-price-signature-minter': 'FixedPriceSignatureMinter',
+  'merkle-drop-minter': 'MerkleDropMinter',
+}

pages/protocol/overview/_meta.ts

@@ -0,0 +1,7 @@
+export default {
+  index: 'Features',
+  design: 'Design',
+  deployments: 'Deployments',
+  gas: 'Gas benchmarks',
+  'erc721a-info': 'ERC721a Info',
+}

pages/sdk/_meta.ts

@@ -0,0 +1,4 @@
+export default {
+  index: 'Getting Started',
+  edition: 'Interacting with editions',
+}

pages/sdk/edition.mdx

@@ -4,7 +4,7 @@ Due to breaking changes between editions, it is important to check the edition v
 
 As a rule of thumb, if your contract was deployed **October 10th 2023 or later**, you should use the V2 edition version of the SDK and you can skip all the `v1` functions, and also lower your bundle size (with automatic tree shaking if available or manually importing only used functions).
 
-```ts
+```ts filename="edition.ts"
 import { soundEditionVersionPublicActions } from '@soundxyz/sdk'
 import { createPublicClient, http } from 'viem'
 import { mainnet } from 'viem/chains'
@@ -33,7 +33,7 @@ After extending the viem instance, you will have full type-safety and autocomple
 
 You can also check [github.com/soundxyz/sdk/examples/nextjs/src/app/v2/page.tsx](https://github.com/soundxyz/sdk/blob/main/examples/nextjs/src/app/v2/page.tsx) as a real world example
 
-```ts
+```ts filename="edition.ts"
 import {
   editionV2PublicActionsCreate,
   editionV2PublicActionsInfo,
@@ -87,7 +87,7 @@ After extending the viem instance, you will have full type-safety and autocomple
 
 You can also check [github.com/soundxyz/sdk/examples/nextjs/src/app/v1](https://github.com/soundxyz/sdk/blob/main/examples/nextjs/src/app/v1) as a real world example
 
-```ts
+```ts filename="edition.ts"
 import { editionV1PublicActions, withMerkleProvider, editionV1WalletActions } from '@soundxyz/sdk'
 import { createPublicClient, createWalletClient, http } from 'viem'
 import { mainnet } from 'viem/chains'

pages/sdk/index.mdx

@@ -10,39 +10,15 @@ Official Sound on-chain development tools for the JavaScript ecosystem leveragin
 
 `@soundxyz/sdk` [![@soundxyz/sdk](https://badge.fury.io/js/@soundxyz%2Fsdk.svg)](https://badge.fury.io/js/@soundxyz%2Fsdk)
 
-```sh
-pnpm add @soundxyz/sdk
-```
-
-```sh
-bun add @soundxyz/sdk
-```
-
-```sh
-yarn add @soundxyz/sdk
-```
-
-```sh
+```sh npm2yarn
 npm install @soundxyz/sdk
 ```
 
 ### Peer Dependencies
 
 Sound.xyz SDK requires the following peer dependencies to be installed:
 
-```sh
-pnpm add viem zod
-```
-
-```sh
-bun add viem zod
-```
-
-```sh
-yarn add viem zod
-```
-
-```sh
+```sh npm2yarn
 npm install viem zod
 ```
 
@@ -68,7 +44,7 @@ The SDK provides direct connection with [www.sound.xyz](https://www.sound.xyz) A
 
 To get an `API Key` contact us on our discord server [`discord.gg/soundxyz`](https://discord.gg/soundxyz)
 
-```ts
+```ts filename="api.ts"
 import { SoundAPI } from '@soundxyz/sdk/api/sound'
 
 // ...
@@ -90,7 +66,7 @@ Currently the SDK provides integrations with [**Lanyard**](https://lanyard.org)
 
 - Lanyard
 
-```ts
+```ts filename="lanyard.ts" {2, 9}
 import { withMerkleProvider } from '@soundxyz/sdk'
 import { LanyardMerkleProvider } from '@soundxyz/sdk/api/lanyard'
 import { createPublicClient, http } from 'viem'
@@ -100,12 +76,11 @@ export const publicClient = createPublicClient({
   chain: mainnet,
   transport: http('...'),
 }).extend(withMerkleProvider(LanyardMerkleProvider))
-// ...
 ```
 
 - Sound.xyz API
 
-```ts
+```ts filename="api.ts"
 import { withMerkleProvider } from '@soundxyz/sdk'
 import { SoundAPI } from '@soundxyz/sdk/api/sound'
 

pages/sound-api/_meta.ts

@@ -0,0 +1,5 @@
+export default {
+  index: 'Getting Started',
+  'making-requests': 'Making Requests',
+  changelog: 'Changelog',
+}