From 56dadfa8bcb66a33eb749c4334a1b6f3196e2743 Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Sun, 8 Dec 2024 21:43:48 +1100 Subject: [PATCH 1/6] Update node-networks-sync.mdx --- apps/nextra/pages/en/network/blockchain/node-networks-sync.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/nextra/pages/en/network/blockchain/node-networks-sync.mdx b/apps/nextra/pages/en/network/blockchain/node-networks-sync.mdx index 56517072f..031cf30c8 100755 --- a/apps/nextra/pages/en/network/blockchain/node-networks-sync.mdx +++ b/apps/nextra/pages/en/network/blockchain/node-networks-sync.mdx @@ -6,7 +6,7 @@ title: "Node Networks and Sync" Validator nodes and fullnodes form a hierarchical structure with validator nodes at the root and fullnodes everywhere else. The Aptos blockchain distinguishes two types of fullnodes: validator fullnodes and public fullnodes. Validator fullnodes connect directly to validator nodes and offer scalability alongside DDoS mitigation. Public fullnodes connect to validator fullnodes (or other public fullnodes) to gain low-latency access to the Aptos network. -![v-fn-network.svg](/docs/v-fn-network.svg) +![v-fn-network.svg](/apps/nextra/public/docs/v-fn-network.svg) ## Node types From cc275ea8369c9abcfbf24123ac8e527d09713dbb Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Sun, 8 Dec 2024 22:11:16 +1100 Subject: [PATCH 2/6] Update resources.mdx --- apps/nextra/pages/en/network/blockchain/resources.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/nextra/pages/en/network/blockchain/resources.mdx b/apps/nextra/pages/en/network/blockchain/resources.mdx index 543250e07..d8c9383a5 100644 --- a/apps/nextra/pages/en/network/blockchain/resources.mdx +++ b/apps/nextra/pages/en/network/blockchain/resources.mdx @@ -9,7 +9,7 @@ On Aptos, on-chain state is organized into resources and modules. These are then ## Resources vs Instances -Move modules define struct definitions. Struct definitions may include the abilities such as `key` or `store`. Resources are struct instance with The `key` ability that are stored in global storage or directly in an account. The `store` ability allows struct instances to be stored within resources. An example here is how the APT coin is stored: CoinStore is the resource that contains the APT coin, while the Coin itself is an instance: +Move modules define struct definitions. Struct definitions may include the abilities such as `key` or `store`. Resources are struct instances with the `key` ability that are stored in global storage or directly in an account. The `store` ability allows struct instances to be stored within resources. An example here is how the APT coin is stored: CoinStore is the resource that contains the APT coin, while the Coin itself is an instance: ```move /// A holder of a specific coin type and associated event handles. From 08740354f933dded7dad4dafb05b23ae07a70a32 Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Sun, 8 Dec 2024 22:51:35 +1100 Subject: [PATCH 3/6] Update ts-sdk.mdx Improving the reflection of links --- apps/nextra/pages/en/build/sdks/ts-sdk.mdx | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/apps/nextra/pages/en/build/sdks/ts-sdk.mdx b/apps/nextra/pages/en/build/sdks/ts-sdk.mdx index bbaa42667..cd702eca0 100644 --- a/apps/nextra/pages/en/build/sdks/ts-sdk.mdx +++ b/apps/nextra/pages/en/build/sdks/ts-sdk.mdx @@ -6,7 +6,7 @@ import { RemoteCodeblock, permalinkFetch, Cards, Card } from '@components/index' export async function getStaticProps() { return await permalinkFetch([ - 'https://github.com/aptos-labs/aptos-ts-sdk/blob/bcde1e3af2f09615015c774fb0c2f5206377346e/examples/typescript/simple_transfer.ts#L77-L91' + simple_transfer ]) } @@ -14,25 +14,19 @@ export async function getStaticProps() {
- ![Github Repo Stars](https://img.shields.io/github/stars/aptos-labs/aptos-ts-sdk) + Github Repo Stars - ![NPM Version](https://img.shields.io/npm/v/%40aptos-labs%2Fts-sdk) + NPM Version - {/* Revisit later if we need these */} - {/* - ![Node Version](https://img.shields.io/node/v/%40aptos-labs%2Fts-sdk) - */} - {/* - ![NPM bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk) - */} - ![Static Badge](https://img.shields.io/badge/SDK_Reference-Docs) + SDK Reference
The TypeScript SDK allows you to connect, explore, and interact on the Aptos blockchain. You can use it to request data, send transactions, set up test environments, and more! + ```bash npm2yarn npm i @aptos-labs/ts-sdk ``` From 785522f03af32fa1d813a1e0b8e767d59192031e Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Sun, 8 Dec 2024 22:57:44 +1100 Subject: [PATCH 4/6] correct typo Update guides.mdx correct typo --- apps/nextra/pages/en/build/guides.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/nextra/pages/en/build/guides.mdx b/apps/nextra/pages/en/build/guides.mdx index 28811c7a6..69d6a0388 100644 --- a/apps/nextra/pages/en/build/guides.mdx +++ b/apps/nextra/pages/en/build/guides.mdx @@ -15,7 +15,7 @@ Choose one of the following guides to learn how to use Aptos for your use cases! Your First NFT - Learn the Aptos Ttoken interface and how to use it to generate your first NFT. + Learn the Aptos Token interface and how to use it to generate your first NFT. Your First Fungible Asset From b4564d5334b8aafd99ded065e05122de69222544 Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Sun, 8 Dec 2024 23:42:08 +1100 Subject: [PATCH 5/6] Update SEO.mdx The image is restored --- .../contribute/setup/SEO.mdx | 52 ++++++++----------- 1 file changed, 23 insertions(+), 29 deletions(-) diff --git a/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx b/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx index 9eaccbd3a..e300b951f 100644 --- a/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx +++ b/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx @@ -8,36 +8,30 @@ import { docsConfig } from '@docs-config'; # SEO -To simplify Nextra SEO / Open Graph configuration, Aptos Nextra projects use the -`docs.config.js` file for many core Open Graph functionalities. +To simplify Nextra SEO / Open Graph configuration, Aptos Nextra projects use the `docs.config.js` file for many core Open Graph functionalities. ### Dynamic Open Graph Images -The Aptos Docs template takes advantage of [Next.js' dynamic opengraph images](https://vercel.com/docs/functions/og-image-generation) -using the edge runtime to ensure low-latency SEO cards and no cold-starts. +The Aptos Docs template takes advantage of [Next.js' dynamic opengraph images](https://vercel.com/docs/functions/og-image-generation) using the edge runtime to ensure low-latency SEO cards and no cold-starts.
-export function DynamicImage({ title }) { - const imageUrl = `${docsConfig.origin}/api/og.png?title=${encodeURIComponent(title)}`; - - return ( - Dynamic Image - ); -} - - +Example Open Graph Image The Open Graph Images are generated dynamically at runtime from `React` components, and served as a png image. This is how we are able to include things like the title of the page in the SEO card. -For more details, checkout `/pages/api/og.png.tsx`. +For more details, checkout the file `/pages/api/og.png.tsx`. - - + + @@ -48,14 +42,14 @@ For more details, checkout `/pages/api/og.png.tsx`. > Note: You may be wondering why we use `og.png.tsx` instead of `og.tsx` as the filename. -We use `og.png.tsx` because after testing it extensively, we learned that -Twitter renders opengraph images if their URLs end with the file extension. +> We use `og.png.tsx` because after testing it extensively, we learned that +> Twitter renders opengraph images if their URLs end with the file extension. ### Testing -You can always check the opengraph image by navigating to `/api/og.png`. +You can always check the opengraph image by navigating to `/api/og.png` in your browser. -(e.g., [`http://localhost:3000/api/og.png`](http://localhost:3000/api/og.png)) +For example: [`http://localhost:3000/api/og.png`](http://localhost:3000/api/og.png) ### Favicon @@ -72,31 +66,31 @@ You can always check the opengraph image by navigating to `/api/og.png`. For other assets located in `public/favicon`, you may want to customize the -website icon. You can do so easily by doing the following: - +website icon. You can do so easily by following these steps: -##### Generate Favicon +### Generate Favicon Navigate to [https://favicon.io/favicon-converter/](https://favicon.io/favicon-converter/). Upload an `svg` file with the logo you'd like to generate your favicon for. -##### Copy assets into `public/favicon` +### Copy assets into `public/favicon` -After generating the assets, favicon.ico should return a zip file containing +After generating the assets, favicon.io will return a zip file containing: - `android-chrome-192x192.png` - `favicon.ico` -- ...so on and so forth +- And other favicon assets -Copy all of these and replace the existing files in `public/favicon` +Copy all of these files and replace the existing files in `public/favicon` -##### Deploy +### Deploy + +Deploy your changes to see the new favicon in action. ### Customizing Open Graph To customize the Open Graph configuration, see `theme.config.tsx`. - From f10a019751ff32603414932c23a50d4ad2eb5b63 Mon Sep 17 00:00:00 2001 From: savvasmoke <136869149+savvar9991@users.noreply.github.com> Date: Wed, 11 Dec 2024 10:29:37 +1100 Subject: [PATCH 6/6] Revert to dynamic image generation Reverted changes back to the original dynamic image generation example to maintain proper documentation of OG image functionality. The static image was temporarily added due to server setup issues, but it's better to keep the correct implementation in the docs even if it requires additional server configuration to work locally. Related issue will be created to track server setup requirements. --- .../contribute/setup/SEO.mdx | 51 ++++++++++--------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx b/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx index e300b951f..e8bc4d4e9 100644 --- a/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx +++ b/apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx @@ -8,30 +8,36 @@ import { docsConfig } from '@docs-config'; # SEO -To simplify Nextra SEO / Open Graph configuration, Aptos Nextra projects use the `docs.config.js` file for many core Open Graph functionalities. +To simplify Nextra SEO / Open Graph configuration, Aptos Nextra projects use the +`docs.config.js` file for many core Open Graph functionalities. ### Dynamic Open Graph Images -The Aptos Docs template takes advantage of [Next.js' dynamic opengraph images](https://vercel.com/docs/functions/og-image-generation) using the edge runtime to ensure low-latency SEO cards and no cold-starts. +The Aptos Docs template takes advantage of [Next.js' dynamic opengraph images](https://vercel.com/docs/functions/og-image-generation) +using the edge runtime to ensure low-latency SEO cards and no cold-starts.
-Example Open Graph Image +export function DynamicImage({ title }) { + const imageUrl = `${docsConfig.origin}/api/og.png?title=${encodeURIComponent(title)}`; + + return ( + Dynamic Image + ); +} + + The Open Graph Images are generated dynamically at runtime from `React` components, and served as a png image. This is how we are able to include things like the title of the page in the SEO card. -For more details, checkout the file `/pages/api/og.png.tsx`. +For more details, checkout `/pages/api/og.png.tsx`. - - + + @@ -42,14 +48,14 @@ For more details, checkout the file `/pages/api/og.png.tsx`. > Note: You may be wondering why we use `og.png.tsx` instead of `og.tsx` as the filename. -> We use `og.png.tsx` because after testing it extensively, we learned that -> Twitter renders opengraph images if their URLs end with the file extension. +We use `og.png.tsx` because after testing it extensively, we learned that +Twitter renders opengraph images if their URLs end with the file extension. ### Testing -You can always check the opengraph image by navigating to `/api/og.png` in your browser. +You can always check the opengraph image by navigating to `/api/og.png`. -For example: [`http://localhost:3000/api/og.png`](http://localhost:3000/api/og.png) +(e.g., [`http://localhost:3000/api/og.png`](http://localhost:3000/api/og.png)) ### Favicon @@ -66,28 +72,27 @@ For example: [`http://localhost:3000/api/og.png`](http://localhost:3000/api/og.p For other assets located in `public/favicon`, you may want to customize the -website icon. You can do so easily by following these steps: +website icon. You can do so easily by doing the following: + -### Generate Favicon +##### Generate Favicon Navigate to [https://favicon.io/favicon-converter/](https://favicon.io/favicon-converter/). Upload an `svg` file with the logo you'd like to generate your favicon for. -### Copy assets into `public/favicon` +##### Copy assets into `public/favicon` -After generating the assets, favicon.io will return a zip file containing: +After generating the assets, favicon.ico should return a zip file containing - `android-chrome-192x192.png` - `favicon.ico` -- And other favicon assets - -Copy all of these files and replace the existing files in `public/favicon` +- ...so on and so forth -### Deploy +Copy all of these and replace the existing files in `public/favicon` -Deploy your changes to see the new favicon in action. +##### Deploy