documentation improvements (typos, links, images) by savvar9991 · Pull Request #731 · aptos-labs/developer-docs

savvar9991 · 2024-12-08T12:46:46Z

The image is restored
Fixed a typo
Improved Ivezual display
replaced non -working link to the correct

Improving the reflection of links

correct typo

The image is restored

vercel · 2024-12-08T12:46:50Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
developer-docs-nextra	❌ Failed (Inspect)			Dec 11, 2024 7:07pm

gregnazario

Generally good, but there are a few updates where changes to img tags don't make sense

gregnazario · 2024-12-10T17:12:41Z

apps/nextra/pages/en/build/sdks/ts-sdk.mdx

  <a target="_blank" href="https://github.com/aptos-labs/aptos-ts-sdk">
-    ![Github Repo Stars](https://img.shields.io/github/stars/aptos-labs/aptos-ts-sdk)
+    <img src="https://img.shields.io/github/stars/aptos-labs/aptos-ts-sdk" alt="Github Repo Stars" />
  </a>
  <a target="_blank" href="https://www.npmjs.com/package/@aptos-labs/ts-sdk">
-    ![NPM Version](https://img.shields.io/npm/v/%40aptos-labs%2Fts-sdk)
+    <img src="https://img.shields.io/npm/v/%40aptos-labs%2Fts-sdk" alt="NPM Version" />
  </a>
-  {/* Revisit later if we need these */}
-  {/* <a target="_blank" href="https://www.npmjs.com/package/@aptos-labs/ts-sdk">
-    ![Node Version](https://img.shields.io/node/v/%40aptos-labs%2Fts-sdk)
-  </a> */}
-  {/* <a target="_blank" href="https://www.npmjs.com/package/@aptos-labs/ts-sdk">
-    ![NPM bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk)
-  </a> */}
  <a target="_blank" href="https://aptos-labs.github.io/aptos-ts-sdk/@aptos-labs/ts-sdk-latest">
-    ![Static Badge](https://img.shields.io/badge/SDK_Reference-Docs)
+    <img src="https://img.shields.io/badge/SDK_Reference-Docs" alt="SDK Reference" />
  </a>


Hmm, these seem to work right now, any reason to change from markdown to HTML?

MDX format is specifically designed to combine the simplicity of Markdown with the power of HTML where needed. In this case, using HTML tags in MDX is a valid and more suitable solution for creating interactive badges
Screenshot before changes:

Screenshot after changes:

The HTML version provides:

Proper handling of external links with target="_blank"

Better visual presentation of badges

gregnazario · 2024-12-10T17:13:42Z

apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx

-export function DynamicImage({ title }) {
-  const imageUrl = `${docsConfig.origin}/api/og.png?title=${encodeURIComponent(title)}`;
-
-  return (
-    <img src={imageUrl} alt="Dynamic Image" />
-  );
-}
-
-<DynamicImage title="Dynamic Image" />
+<img 
+  src="https://assets-global.website-files.com/606f63778ec431ec1b930f1f/63dbd502218a274f2a602968_aptos.png" 
+  alt="Example Open Graph Image" 
+  style="width: 100%; max-width: 800px; height: auto; border: 1px solid #eaeaea; border-radius: 8px; margin: 20px 0" 
+/>


I think this is supposed to be a dynamic image example, so it doesn't make much sense here to change to an img

You're right about this being a dynamic image example. I made these changes because the dynamic image generation wasn't working due to server issues (the server needs to be running with @vercel/og package and proper Edge Runtime setup for OG image generation to work).

I'll create a separate issue to track and fix the server setup required for dynamic image generation. For now, I'll revert these changes to keep the original dynamic image example in the documentation.

gregnazario · 2024-12-10T17:14:56Z

apps/nextra/pages/en/network/blockchain/node-networks-sync.mdx

 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)


This image is currently working? I think it should stay how it is

Actually, the image with the original path isn't working - it shows as a broken image. The new path I added points to the correct location of the file in the project structure (/apps/nextra/public/docs/v-fn-network.svg), which makes the image display properly.

Would you like me to show you the difference between how it looks with both paths?
Screenshot before changes:

Screenshot after changes:

gregnazario · 2024-12-10T17:15:55Z

apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx

-##### 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


These should be 4 #, as they're part of the favicon section, but I'll accept 3 for now, as it'll match above.

#### Generate Favicon

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.

savvar9991

I've addressed the feedback:

For node-networks-sync.mdx: Fixed the image path to correctly display the network diagram (provided before/after screenshots showing the fix)
For ts-sdk.mdx: Will keep the original dynamic image implementation and create a separate issue for server setup requirements

savvar9991 · 2024-12-10T22:01:15Z

apps/nextra/pages/en/build/sdks/ts-sdk.mdx

  <a target="_blank" href="https://github.com/aptos-labs/aptos-ts-sdk">
-    ![Github Repo Stars](https://img.shields.io/github/stars/aptos-labs/aptos-ts-sdk)
+    <img src="https://img.shields.io/github/stars/aptos-labs/aptos-ts-sdk" alt="Github Repo Stars" />
  </a>
  <a target="_blank" href="https://www.npmjs.com/package/@aptos-labs/ts-sdk">
-    ![NPM Version](https://img.shields.io/npm/v/%40aptos-labs%2Fts-sdk)
+    <img src="https://img.shields.io/npm/v/%40aptos-labs%2Fts-sdk" alt="NPM Version" />
  </a>
-  {/* Revisit later if we need these */}
-  {/* <a target="_blank" href="https://www.npmjs.com/package/@aptos-labs/ts-sdk">
-    ![Node Version](https://img.shields.io/node/v/%40aptos-labs%2Fts-sdk)
-  </a> */}
-  {/* <a target="_blank" href="https://www.npmjs.com/package/@aptos-labs/ts-sdk">
-    ![NPM bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk)
-  </a> */}
  <a target="_blank" href="https://aptos-labs.github.io/aptos-ts-sdk/@aptos-labs/ts-sdk-latest">
-    ![Static Badge](https://img.shields.io/badge/SDK_Reference-Docs)
+    <img src="https://img.shields.io/badge/SDK_Reference-Docs" alt="SDK Reference" />
  </a>


MDX format is specifically designed to combine the simplicity of Markdown with the power of HTML where needed. In this case, using HTML tags in MDX is a valid and more suitable solution for creating interactive badges
Screenshot before changes:

Screenshot after changes:

The HTML version provides:

Proper handling of external links with target="_blank"

Better visual presentation of badges

savvar9991 · 2024-12-10T23:24:36Z

apps/nextra/pages/en/developer-platforms/contribute/setup/SEO.mdx

-export function DynamicImage({ title }) {
-  const imageUrl = `${docsConfig.origin}/api/og.png?title=${encodeURIComponent(title)}`;
-
-  return (
-    <img src={imageUrl} alt="Dynamic Image" />
-  );
-}
-
-<DynamicImage title="Dynamic Image" />
+<img 
+  src="https://assets-global.website-files.com/606f63778ec431ec1b930f1f/63dbd502218a274f2a602968_aptos.png" 
+  alt="Example Open Graph Image" 
+  style="width: 100%; max-width: 800px; height: auto; border: 1px solid #eaeaea; border-radius: 8px; margin: 20px 0" 
+/>


You're right about this being a dynamic image example. I made these changes because the dynamic image generation wasn't working due to server issues (the server needs to be running with @vercel/og package and proper Edge Runtime setup for OG image generation to work).

I'll create a separate issue to track and fix the server setup required for dynamic image generation. For now, I'll revert these changes to keep the original dynamic image example in the documentation.

savvar9991 · 2024-12-11T02:34:19Z

apps/nextra/pages/en/network/blockchain/node-networks-sync.mdx

 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)


Actually, the image with the original path isn't working - it shows as a broken image. The new path I added points to the correct location of the file in the project structure (/apps/nextra/public/docs/v-fn-network.svg), which makes the image display properly.

Would you like me to show you the difference between how it looks with both paths?
Screenshot before changes:

Screenshot after changes:

gregnazario · 2024-12-11T18:53:46Z

Okay, I get it now, you're looking at GitHub, rather than the website aptos.dev directly. Mainly focused on readability there, so will need to double check on the preview site

github-actions · 2025-01-26T02:00:48Z

This issue is stale because it has been open 45 days with no activity. Remove the stale label, comment or push a commit - otherwise this will be closed in 15 days.

savvar9991 added 5 commits December 8, 2024 21:43

Update node-networks-sync.mdx

56dadfa

Update resources.mdx

cc275ea

Update ts-sdk.mdx

0874035

Improving the reflection of links

correct typo Update guides.mdx

785522f

correct typo

Update SEO.mdx

b4564d5

The image is restored

savvar9991 requested review from a team, gregnazario, hariria and igor-p as code owners December 8, 2024 12:46

vercel bot had a problem deploying to Preview December 8, 2024 12:48 Failure

ziaptos approved these changes Dec 8, 2024

View reviewed changes

gregnazario suggested changes Dec 10, 2024

View reviewed changes

vercel bot had a problem deploying to Preview December 10, 2024 23:31 Failure

savvar9991 commented Dec 11, 2024

View reviewed changes

Merge branch 'main' into update-docs

05b7ded

vercel bot had a problem deploying to Preview December 11, 2024 19:07 Failure

github-actions bot added the Stale label Jan 26, 2025

github-actions bot closed this Feb 11, 2025

Conversation

savvar9991 commented Dec 8, 2024

Uh oh!

vercel bot commented Dec 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gregnazario left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

savvar9991 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gregnazario commented Dec 11, 2024

Uh oh!

github-actions bot commented Jan 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vercel bot commented Dec 8, 2024 •

edited

Loading