feat: sdk developer guide (#382)

janb87 · web-flow · commit 8b642610ee50 · 2025-04-30T20:03:23.000+02:00
<img width="2510" alt="Screenshot 2025-04-30 at 18 52 55" src="https://github.com/user-attachments/assets/326432fc-d071-42a2-aef4-37574d0f1946" /> ## Summary by Sourcery Extend SDK documentation generation script to support multiple SDK documentation files New Features: - Generate documentation for multiple SettleMint SDK modules (CLI, Viem, Minio, Portal) Enhancements: - Refactor documentation generation function to be more flexible - Improve title formatting with better capitalization and spacing
diff --git a/.gitignore b/.gitignore
@@ -35,5 +35,5 @@ next-env.d.ts
 content/docs/building-with-settlemint/cli/command-reference.mdx
 content/docs/building-with-settlemint/cli/settlemint/**/*.mdx
 content/docs/building-with-settlemint/cli/settlemint/**/meta.json
-content/snippets/dev-tools/cli.mdx
+content/snippets/dev-tools/*.mdx
 content/snippets/dev-tools/settlemint-*.tmp
diff --git a/bun.lock b/bun.lock
diff --git a/content/docs/building-with-settlemint/building-with-sdk/blockscout.mdx b/content/docs/building-with-settlemint/building-with-sdk/blockscout.mdx
@@ -0,0 +1,7 @@
+---
+title: "Blockscout Explorer"
+description:
+  "Integrating Blockscout blockchain explorer in your SettleMint dApp"
+---
+
+<include>../../../snippets/dev-tools/blockscout.mdx</include>
diff --git a/content/docs/building-with-settlemint/building-with-sdk/hasura.mdx b/content/docs/building-with-settlemint/building-with-sdk/hasura.mdx
@@ -0,0 +1,6 @@
+---
+title: "Hasura"
+description: "Integrating Hasura in your SettleMint dApp"
+---
+
+<include>../../../snippets/dev-tools/hasura.mdx</include>
diff --git a/content/docs/building-with-settlemint/building-with-sdk/ipfs.mdx b/content/docs/building-with-settlemint/building-with-sdk/ipfs.mdx
@@ -0,0 +1,6 @@
+---
+title: "IPFS Storage"
+description: "Integrating IPFS storage in your SettleMint dApp"
+---
+
+<include>../../../snippets/dev-tools/ipfs.mdx</include>
diff --git a/content/docs/building-with-settlemint/building-with-sdk/meta.json b/content/docs/building-with-settlemint/building-with-sdk/meta.json
@@ -0,0 +1,13 @@
+{
+  "title": "SDK Developer Guide",
+  "description": "Building with the SettleMint SDK",
+  "pages": [
+    "portal",
+    "hasura",
+    "the-graph",
+    "minio",
+    "ipfs",
+    "blockscout",
+    "viem"
+  ]
+}
diff --git a/content/docs/building-with-settlemint/building-with-sdk/minio.mdx b/content/docs/building-with-settlemint/building-with-sdk/minio.mdx
@@ -0,0 +1,6 @@
+---
+title: "MinIO/S3 storage"
+description: "Integrating MinIO/S3 storage in your SettleMint dApp"
+---
+
+<include>../../../snippets/dev-tools/minio.mdx</include>
diff --git a/content/docs/building-with-settlemint/building-with-sdk/portal.mdx b/content/docs/building-with-settlemint/building-with-sdk/portal.mdx
@@ -0,0 +1,6 @@
+---
+title: "Smart Contract Portal"
+description: "Using the Smart Contract Portal in your SettleMint dApp"
+---
+
+<include>../../../snippets/dev-tools/portal.mdx</include>
diff --git a/content/docs/building-with-settlemint/building-with-sdk/the-graph.mdx b/content/docs/building-with-settlemint/building-with-sdk/the-graph.mdx
@@ -0,0 +1,6 @@
+---
+title: "The Graph"
+description: "Integrating The Graph in your SettleMint dApp"
+---
+
+<include>../../../snippets/dev-tools/the-graph.mdx</include>
diff --git a/content/docs/building-with-settlemint/building-with-sdk/viem.mdx b/content/docs/building-with-settlemint/building-with-sdk/viem.mdx
@@ -0,0 +1,7 @@
+---
+title: "Viem"
+description:
+  "Integrating Viem for Ethereum interactions in your SettleMint dApp"
+---
+
+<include>../../../snippets/dev-tools/viem.mdx</include>
diff --git a/content/docs/building-with-settlemint/meta.json b/content/docs/building-with-settlemint/meta.json
@@ -8,6 +8,7 @@
     "evm-chains-guide",
     "hedera-hashgraph-guide",
     "hyperledger-fabric-guide",
+    "building-with-sdk",
     "cli"
   ]
 }
diff --git a/package.json b/package.json
@@ -16,7 +16,14 @@
   },
   "dependencies": {
     "@next/third-parties": "15.3.1",
-    "@settlemint/sdk-cli": "2.2.0",
+    "@settlemint/sdk-blockscout": "2.2.1",
+    "@settlemint/sdk-cli": "2.2.1",
+    "@settlemint/sdk-hasura": "2.2.1",
+    "@settlemint/sdk-ipfs": "2.2.1",
+    "@settlemint/sdk-minio": "2.2.1",
+    "@settlemint/sdk-portal": "2.2.1",
+    "@settlemint/sdk-thegraph": "2.2.1",
+    "@settlemint/sdk-viem": "2.2.1",
     "@theguild/remark-mermaid": "0.3.0",
     "class-variance-authority": "0.7.1",
     "clsx": "2.1.1",
diff --git a/scripts/generate-sdk-docs.ts b/scripts/generate-sdk-docs.ts
@@ -4,10 +4,9 @@ import { dependencies } from "../package.json";
 
 const version = dependencies["@settlemint/sdk-cli"];
 
-async function generateCliDocs() {
+async function generateSnippet(sdkDocsPath: string, outputFilename: string) {
   console.log("[Generate SDK Docs] Starting SDK documentation generation...");
 
-  const sdkDocsPath = "./node_modules/@settlemint/sdk-cli/README.md";
   console.log(
     `[Generate SDK Docs] Reading SDK documentation from: ${sdkDocsPath}`
   );
@@ -24,7 +23,7 @@ async function generateCliDocs() {
   console.log(`[Generate SDK Docs] Creating target directory: ${targetDir}`);
   await mkdir(targetDir, { recursive: true });
 
-  const outputPath = join(targetDir, "cli.mdx");
+  const outputPath = join(targetDir, outputFilename);
   console.log(`[Generate SDK Docs] Writing content to: ${outputPath}`);
   // replace 'https://github.com/settlemint/sdk/tree/v2.2.0/sdk/cli/docs/settlemint.md)' with '/building-with-settlemint/cli/command-reference'
   const updatedContent = content.replace(
@@ -143,9 +142,8 @@ async function generateMetaJsonFiles(
     const metaPath = join(cliReferenceTargetDir, dir, "meta.json");
     const dirBasename = basename(dir);
 
-    // Format the label and title with first letter capitalized
-    const formattedName =
-      dirBasename.charAt(0).toUpperCase() + dirBasename.slice(1);
+    // Format the label and title
+    const formattedName = escapeTitle(dirBasename);
 
     const metaContent = {
       label: dir === "settlemint" ? "Commands" : formattedName,
@@ -295,12 +293,47 @@ description: CLI command reference for SettleMint platform
 ${content}`;
   }
   return `---
-title: ${title.charAt(0).toUpperCase() + title.slice(1)}
+title: ${escapeTitle(title)}
 ---
 
 ${content}`;
 }
 
+function escapeTitle(title: string): string {
+  return title.charAt(0).toUpperCase() + title.slice(1).replace(/-/g, " ");
+}
+
 // Execute the functions
-await generateCliDocs();
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-cli/README.md",
+  "cli.mdx"
+);
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-viem/README.md",
+  "viem.mdx"
+);
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-minio/README.md",
+  "minio.mdx"
+);
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-portal/README.md",
+  "portal.mdx"
+);
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-hasura/README.md",
+  "hasura.mdx"
+);
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-blockscout/README.md",
+  "blockscout.mdx"
+);
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-ipfs/README.md",
+  "ipfs.mdx"
+);
+await generateSnippet(
+  "./node_modules/@settlemint/sdk-thegraph/README.md",
+  "the-graph.mdx"
+);
 await generateCliCommandDocs();
