Skip to content

Commit a6a5ab9

Browse files
fix(docs): correct SDK package links and add template cleanup note (#602)
- 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 ## Summary by Sourcery Fix SDK documentation by updating package links to point to the GitHub repository and add a note on removing unused sample contracts from the Empty template Documentation: - Updated SDK package links to point to GitHub repository folders instead of internal docs - Added an informational callout advising removal of unused sample contracts (e.g., Counter) from the Empty template before production Co-authored-by: saeeddawod <saeed.dawod@gmail.com>
1 parent 3887556 commit a6a5ab9

2 files changed

Lines changed: 17 additions & 13 deletions

File tree

content/docs/platform-components/dev-tools/code-studio.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,10 @@ The programming languages for smart contracts differ depending on the protocol:
174174

175175
---
176176

177+
<Callout type="info">
178+
**Note**: The Empty template includes sample contracts (e.g., Counter) for reference. Remove any unused contracts and their references before deploying to production.
179+
</Callout>
180+
177181
### Chaincode templates (hyperledger fabric)
178182

179183
| Template | Description |

content/docs/platform-components/dev-tools/sdk.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,19 +58,19 @@ functionalities, allowing developers to integrate only the components they need.
5858

5959
| Package | Description | NPM |
6060
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
61-
| [`@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) |
62-
| [`@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) |
63-
| [`@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) |
64-
| [`@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) |
65-
| [`@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) |
66-
| [`@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) |
67-
| [`@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) |
68-
| [`@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) |
69-
| [`@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) |
70-
| [`@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) |
71-
| [`@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) |
72-
| [`@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) |
73-
| [`@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) |
61+
| [`@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) |
62+
| [`@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) |
63+
| [`@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) |
64+
| [`@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) |
65+
| [`@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) |
66+
| [`@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) |
67+
| [`@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) |
68+
| [`@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) |
69+
| [`@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) |
70+
| [`@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) |
71+
| [`@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) |
72+
| [`@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) |
73+
| [`@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) |
7474

7575
## How to contribute
7676

0 commit comments

Comments
 (0)