Skip to content

Commit 643472f

Browse files
authored
fix: improve middleware docs and remove non existing sdk api's (#378)
## Summary by Sourcery Refactor documentation by introducing reusable snippets for middleware instructions, standardizing the term "Smart contract portal", and removing potentially destructive `delete` operations from code examples. Documentation: - Create reusable snippets for creating and managing middleware. - Update documentation guides (EVM, Hedera) and component pages to use the new middleware snippets. - Standardize terminology by renaming "API Portal" to "Smart contract portal" throughout the documentation. - Remove potentially unsafe `delete` command examples for various platform components (networks, storage, smart contract sets, middleware). - Correct the SDK documentation link in the release notes. - Improve formatting with consistent line breaks and code block language identifiers.
1 parent f1c8581 commit 643472f

30 files changed

+346
-4708
lines changed

content/docs/blockchain-and-ai/open-ai-nodes-and-pg-vector.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This guide will demonstrate how to use the **SettleMint Integration Studio** to
1111
create a flow that incorporates OpenAI nodes for vectorization and utilizes the
1212
`pgvector` plugin in Hasura for similarity searches. If you are new to
1313
SettleMint, check out the
14-
[Getting Started Guide](/launching-the-platform/managed-cloud-deployment/quickstart).
14+
[Getting Started Guide](/building-with-settlemint/getting-started).
1515

1616
In this guide, you will learn to create workflows that:
1717

@@ -208,4 +208,4 @@ For further resources, check out:
208208
---
209209

210210
This guide should enable you to build AI-powered workflows with SettleMint's new
211-
OpenAI nodes and `pgvector` support in Hasura for efficient similarity searches.
211+
OpenAI nodes and `pgvector` support in Hasura for efficient similarity searches.

content/docs/building-with-settlemint/evm-chains-guide/add-network-and-nodes.mdx

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -157,11 +157,6 @@ You can perform the same action via the SettleMint SDK CLI as well -
157157
console.log('Network details:', network);
158158
};
159159

160-
// Delete network
161-
const deleteNetwork = async () => {
162-
await client.blockchainNetwork.delete("network-unique-name");
163-
};
164-
165160
// Restart network
166161
const restartNetwork = async () => {
167162
await client.blockchainNetwork.restart("network-unique-name");
@@ -204,9 +199,6 @@ Network management can be done via SettleMint SDK CLI using these commands -
204199
# Get network details
205200
settlemint platform read blockchain-network <network-name>
206201

207-
# Delete network
208-
settlemint platform delete blockchain-network <network-name>
209-
210202
# Restart network
211203
settlemint platform restart blockchain-network <network-name>
212204
```
@@ -230,9 +222,6 @@ Network management can be done via SettleMint SDK CLI using these commands -
230222
// Get network details
231223
await client.blockchainNetwork.read("network-unique-name");
232224

233-
// Delete network
234-
await client.blockchainNetwork.delete("network-unique-name");
235-
236225
// Restart network
237226
await client.blockchainNetwork.restart("network-unique-name");
238227
```
@@ -418,11 +407,11 @@ network.
418407

419408
<br></br>
420409
<div style={{
421-
backgroundColor: "#D1E5E8",
422-
color: "#000000",
410+
backgroundColor: "#D1E5E8",
411+
color: "#000000",
423412
padding: "0.5px 10px 10px 10px",
424-
borderRadius: "10px",
425-
fontSize: "18px",
413+
borderRadius: "10px",
414+
fontSize: "18px",
426415
fontWeight: "light",
427416
lineHeight: "1.5",
428417
textAlign: "left"

content/docs/building-with-settlemint/evm-chains-guide/add-private-keys.mdx

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ private key, ECDSA P256, HD ECDSA P256, or HSM ECDSA P256.
8787
4. Click **confirm** to create the key
8888

8989
</Tab>
90-
90+
9191
<Tab value="SDK CLI">
9292
```bash
9393
# Create Accessible ECDSA P256 key
@@ -105,7 +105,7 @@ private key, ECDSA P256, HD ECDSA P256, or HSM ECDSA P256.
105105
```
106106

107107
</Tab>
108-
108+
109109
<Tab value="SDK JS">
110110
```typescript
111111
import { createSettleMintClient } from '@settlemint/sdk-js';
@@ -187,7 +187,7 @@ transaction.
187187
- Check balances
188188
- Fund the key
189189
</Tab>
190-
190+
191191
<Tab value="SDK CLI">
192192
```bash
193193
# List all private keys
@@ -201,7 +201,7 @@ transaction.
201201
```
202202

203203
</Tab>
204-
204+
205205
<Tab value="SDK JS">
206206
```typescript
207207
// List private keys
@@ -250,7 +250,7 @@ also simplifies wallet recovery since all wallets are derived from a single
250250
master key. User wallets use the same signing proxy to sign transactions with
251251
the corresponding user private key.
252252

253-
## Create and set up user wallets
253+
## Create and setup user wallets
254254

255255
To set up your user wallets, navigate to your application, click **private
256256
keys** in the left navigation, and then click **create a private key**. This
@@ -273,7 +273,7 @@ entire tree of ECDSA key pairs in a structured and repeatable way. This system
273273
follows the BIP-32 standard and includes concepts like key derivation paths and
274274
chain codes.
275275

276-
<br></br>
276+
<br />
277277
The reason HD wallets are suitable for managing wallets is that they support
278278
deterministic key generation. You can recreate the full wallet from just the
279279
seed phrase. Each new account or address is simply a derived key from a known
@@ -295,15 +295,13 @@ Remember that for networks that require gas to perform a transaction, the user
295295
wallet should contain enough funds to cover the gas price. You can fund it using
296296
the address displayed in the list.
297297

298-
<br></br>
299-
300-
<br></br>
298+
<br /><br />
301299
<div style={{
302-
backgroundColor: "#D1E5E8",
303-
color: "#000000",
300+
backgroundColor: "#D1E5E8",
301+
color: "#000000",
304302
padding: "0.5px 10px 10px 10px",
305-
borderRadius: "10px",
306-
fontSize: "18px",
303+
borderRadius: "10px",
304+
fontSize: "18px",
307305
fontWeight: "light",
308306
lineHeight: "1.5",
309307
textAlign: "left"

0 commit comments

Comments
 (0)