From d3841b0d316856ba3a125c00f71d51ec20de4445 Mon Sep 17 00:00:00 2001 From: saeeddawod Date: Fri, 18 Jul 2025 12:54:42 +0700 Subject: [PATCH] fix(docs): correct SDK package links and add template cleanup note - Fix SDK package links to point to GitHub repo folders instead of internal docs - Add note about removing unused sample contracts from Empty template - Addresses customer feedback about Counter contract references --- .../dev-tools/code-studio.mdx | 4 +++ .../platform-components/dev-tools/sdk.mdx | 26 +++++++++---------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/content/docs/platform-components/dev-tools/code-studio.mdx b/content/docs/platform-components/dev-tools/code-studio.mdx index 25d6b268..2e12b614 100644 --- a/content/docs/platform-components/dev-tools/code-studio.mdx +++ b/content/docs/platform-components/dev-tools/code-studio.mdx @@ -174,6 +174,10 @@ The programming languages for smart contracts differ depending on the protocol: --- + +**Note**: The Empty template includes sample contracts (e.g., Counter) for reference. Remove any unused contracts and their references before deploying to production. + + ### Chaincode templates (hyperledger fabric) | Template | Description | diff --git a/content/docs/platform-components/dev-tools/sdk.mdx b/content/docs/platform-components/dev-tools/sdk.mdx index 71aa1c50..50badfeb 100644 --- a/content/docs/platform-components/dev-tools/sdk.mdx +++ b/content/docs/platform-components/dev-tools/sdk.mdx @@ -58,19 +58,19 @@ functionalities, allowing developers to integrate only the components they need. | Package | Description | NPM | | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| [`@settlemint/sdk-blockscout`](sdk/blockscout) | Blockscout integration module for SettleMint SDK, enabling blockchain explorer and analytics functionality | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-blockscout)](https://www.npmjs.com/package/@settlemint/sdk-blockscout) | -| [`@settlemint/sdk-cli`](sdk/cli) | Command-line interface for SettleMint SDK, providing development tools and project management capabilities | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-cli)](https://www.npmjs.com/package/@settlemint/sdk-cli) | -| [`@settlemint/sdk-eas`](sdk/eas) | Ethereum Attestation Service (EAS) integration for SettleMint SDK | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-eas)](https://www.npmjs.com/package/@settlemint/sdk-eas) | -| [`@settlemint/sdk-hasura`](sdk/hasura) | Hasura and PostgreSQL integration module for SettleMint SDK, enabling database operations and GraphQL queries | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-hasura)](https://www.npmjs.com/package/@settlemint/sdk-hasura) | -| [`@settlemint/sdk-ipfs`](sdk/ipfs) | IPFS integration module for SettleMint SDK, enabling decentralized storage and content addressing | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-ipfs)](https://www.npmjs.com/package/@settlemint/sdk-ipfs) | -| [`@settlemint/sdk-js`](sdk/js) | Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-js)](https://www.npmjs.com/package/@settlemint/sdk-js) | -| [`@settlemint/sdk-mcp`](sdk/mcp) | MCP interface for SettleMint SDK, providing development tools and project management capabilities | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-mcp)](https://www.npmjs.com/package/@settlemint/sdk-mcp) | -| [`@settlemint/sdk-minio`](sdk/minio) | MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-minio)](https://www.npmjs.com/package/@settlemint/sdk-minio) | -| [`@settlemint/sdk-next`](sdk/next) | Next.js integration module for SettleMint SDK, providing React components and middleware for web applications | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-next)](https://www.npmjs.com/package/@settlemint/sdk-next) | -| [`@settlemint/sdk-portal`](sdk/portal) | Portal API client module for SettleMint SDK, providing access to smart contract portal services and APIs | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-portal)](https://www.npmjs.com/package/@settlemint/sdk-portal) | -| [`@settlemint/sdk-thegraph`](sdk/thegraph) | TheGraph integration module for SettleMint SDK, enabling querying and indexing of blockchain data through subgraphs | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-thegraph)](https://www.npmjs.com/package/@settlemint/sdk-thegraph) | -| [`@settlemint/sdk-utils`](sdk/utils) | Shared utilities and helper functions for SettleMint SDK modules | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-utils)](https://www.npmjs.com/package/@settlemint/sdk-utils) | -| [`@settlemint/sdk-viem`](sdk/viem) | Viem (TypeScript Interface for Ethereum) module for SettleMint SDK | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-viem)](https://www.npmjs.com/package/@settlemint/sdk-viem) | +| [`@settlemint/sdk-blockscout`](https://github.com/settlemint/sdk/tree/main/sdk/blockscout) | Blockscout integration module for SettleMint SDK, enabling blockchain explorer and analytics functionality | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-blockscout)](https://www.npmjs.com/package/@settlemint/sdk-blockscout) | +| [`@settlemint/sdk-cli`](https://github.com/settlemint/sdk/tree/main/sdk/cli) | Command-line interface for SettleMint SDK, providing development tools and project management capabilities | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-cli)](https://www.npmjs.com/package/@settlemint/sdk-cli) | +| [`@settlemint/sdk-eas`](https://github.com/settlemint/sdk/tree/main/sdk/eas) | Ethereum Attestation Service (EAS) integration for SettleMint SDK | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-eas)](https://www.npmjs.com/package/@settlemint/sdk-eas) | +| [`@settlemint/sdk-hasura`](https://github.com/settlemint/sdk/tree/main/sdk/hasura) | Hasura and PostgreSQL integration module for SettleMint SDK, enabling database operations and GraphQL queries | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-hasura)](https://www.npmjs.com/package/@settlemint/sdk-hasura) | +| [`@settlemint/sdk-ipfs`](https://github.com/settlemint/sdk/tree/main/sdk/ipfs) | IPFS integration module for SettleMint SDK, enabling decentralized storage and content addressing | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-ipfs)](https://www.npmjs.com/package/@settlemint/sdk-ipfs) | +| [`@settlemint/sdk-js`](https://github.com/settlemint/sdk/tree/main/sdk/js) | Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-js)](https://www.npmjs.com/package/@settlemint/sdk-js) | +| [`@settlemint/sdk-mcp`](https://github.com/settlemint/sdk/tree/main/sdk/mcp) | MCP interface for SettleMint SDK, providing development tools and project management capabilities | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-mcp)](https://www.npmjs.com/package/@settlemint/sdk-mcp) | +| [`@settlemint/sdk-minio`](https://github.com/settlemint/sdk/tree/main/sdk/minio) | MinIO integration module for SettleMint SDK, providing S3-compatible object storage capabilities | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-minio)](https://www.npmjs.com/package/@settlemint/sdk-minio) | +| [`@settlemint/sdk-next`](https://github.com/settlemint/sdk/tree/main/sdk/next) | Next.js integration module for SettleMint SDK, providing React components and middleware for web applications | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-next)](https://www.npmjs.com/package/@settlemint/sdk-next) | +| [`@settlemint/sdk-portal`](https://github.com/settlemint/sdk/tree/main/sdk/portal) | Portal API client module for SettleMint SDK, providing access to smart contract portal services and APIs | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-portal)](https://www.npmjs.com/package/@settlemint/sdk-portal) | +| [`@settlemint/sdk-thegraph`](https://github.com/settlemint/sdk/tree/main/sdk/thegraph) | TheGraph integration module for SettleMint SDK, enabling querying and indexing of blockchain data through subgraphs | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-thegraph)](https://www.npmjs.com/package/@settlemint/sdk-thegraph) | +| [`@settlemint/sdk-utils`](https://github.com/settlemint/sdk/tree/main/sdk/utils) | Shared utilities and helper functions for SettleMint SDK modules | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-utils)](https://www.npmjs.com/package/@settlemint/sdk-utils) | +| [`@settlemint/sdk-viem`](https://github.com/settlemint/sdk/tree/main/sdk/viem) | Viem (TypeScript Interface for Ethereum) module for SettleMint SDK | [![npm version](https://img.shields.io/npm/v/@settlemint/sdk-viem)](https://www.npmjs.com/package/@settlemint/sdk-viem) | ## How to contribute