Skip to content

Commit 382f7bf

Browse files
authored
Gyan/fix sentence case issues (#255)
## Summary by Sourcery Fix sentence case and abbreviation handling in documentation and formatting scripts Bug Fixes: - Resolved issues with markdown formatting preservation - Fixed inconsistent capitalization in documentation headings Enhancements: - Improved text case conversion logic in heading and sentence formatting - Enhanced abbreviation preservation in text transformations Documentation: - Standardized heading capitalization across multiple documentation files - Removed placeholder abbreviation markers Chores: - Updated list of recognized abbreviations - Cleaned up text processing functions
1 parent 74cba91 commit 382f7bf

File tree

8 files changed

+26
-24
lines changed

8 files changed

+26
-24
lines changed

content/docs/building-with-settlemint/evm-chains-guide/setup-code-studio.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ Smart contract sets allow you to incorporate **business logic** into your
8383
application by deploying smart contracts that run on the blockchain. You can add
8484
a smart contract set via different methods as part of your development workflow.
8585

86-
## IDE project structure**
86+
87+
## IDE project structure
88+
8789

8890
The EVM IDE project structure in code studio is thoughtfully organized to
8991
support efficient smart contract development, testing, and deployment. Each

content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-code-studio.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ Smart contract sets allow you to incorporate **business logic** into your
8383
application by deploying smart contracts that run on the blockchain. You can add
8484
a smart contract set via different methods as part of your development workflow.
8585

86-
## IDE project structure**
86+
87+
## IDE project structure
88+
8789

8890
The EVM IDE project structure in code studio is thoughtfully organized to
8991
support efficient smart contract development, testing, and deployment. Each

content/docs/knowledge-bank/keys-and-security.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import { Card } from "fumadocs-ui/components/card";
3535

3636
## Security infrastructure
3737

38-
### 1. Hardware security modules (hsm)
38+
### 1. Hardware security modules (HSM)
3939

4040
```typescript
4141
interface HSMConfig {

content/docs/platform-components/blockchain-infrastructure/blockchain-nodes.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,9 @@ Real-time logs provide visibility into **node operations**, including:
403403
The **Hyperledger Fabric Node Dashboard** is designed to monitor and manage
404404
Fabric nodes, focusing on consensus, network identity, and operational metrics.
405405

406-
### 2.1 details tab
406+
407+
### 2.1 Details tab
408+
407409

408410
![Fabric Node Info](../../../img/platfrom-components/fabric-node-info.png)
409411

content/docs/platform-components/blockchain-infrastructure/load-balancer.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,19 @@ distribution, and failover mechanisms**.
9797
SettleMint allows **flexible deployment** of its blockchain load balancer based
9898
on the specific needs of an organization:
9999

100-
### **1. cloud-based load balancer**
100+
### **1. Cloud-based load balancer**
101101

102102
- Deployed on cloud infrastructure (AWS, Azure, GCP) with **auto-scaling
103103
capabilities**.
104104
- Ideal for **enterprise-grade blockchain solutions**.
105105

106-
### **2. on-premises load balancer**
106+
### **2. On-premises load balancer**
107107

108108
- Runs within a **private network** for **enhanced security and regulatory
109109
compliance**.
110110
- Suitable for **financial, government, and enterprise applications**.
111111

112-
### **3. hybrid load balancer**
112+
### **3. Hybrid load balancer**
113113

114114
- A combination of **cloud and on-prem** nodes to balance traffic dynamically.
115115
- Enables **cost efficiency and scalability** while ensuring **data privacy**.

content/docs/platform-components/blockchain-infrastructure/transaction-signer.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,14 @@ nodes:
7676

7777
![Transaction Signer Keys Mapping](../../../img/platfrom-components/signer-key-mapping.png)
7878

79-
### **2. hardware security module (hsm) or vault integration**
79+
### **2. Hardware security module (HSM) or vault integration**
8080

8181
- SettleMint allows integration with **AWS KMS, HashiCorp Vault, and other
8282
secure key management services**.
8383
- This approach keeps private keys **off-chain and protected from unauthorized
8484
access**.
8585

86-
### **3. remote signing via api**
86+
### **3. Remote signing via API**
8787

8888
- Instead of storing private keys on nodes, SettleMint supports **external
8989
signing services** that handle digital signatures remotely.

content/docs/use-case-guides/asset-tokenization.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,6 @@ For more information on how to add a smart contract set,
143143

144144
### 2. Opening the integrated development environment IDE
145145

146-
147146
To add and edit the smart contract code, you will use the IDE.
148147

149148
![Open Fullscreen](../../img/developer-guides/asset-tokenization/open-fullscreen.png)

format-headings.ts

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ const ABBREVIATIONS = [
88
"AI",
99
"MCP",
1010
"IDE",
11+
"HSM",
12+
"API",
13+
"SDK",
14+
"URL",
15+
"JSON",
16+
"GraphQL",
1117

1218
// Add more abbreviations here in UPPERCASE
1319
// Example:
@@ -83,24 +89,15 @@ function processLine(line: string): string {
8389
return line;
8490
}
8591

86-
// Updated regex to handle all numbering patterns, but preserve existing formatting
92+
// Updated regex to handle all cases including spaced asterisks
8793
const headingRegex =
88-
/^(#{1,6})\s*(\*\*)?(?:(\d{1,2}\.(?:\d{1,2})?)\.\s*)?([a-zA-Z].*?)(\*\*)?$/;
94+
/^(#{1,6}\s*\*{0,2}\s*(?:\d+(?:\.\d+)?\.?\s*)?)([a-zA-Z])(.*?)$/;
8995
const match = line.match(headingRegex);
9096

9197
if (match) {
92-
const [_, hashes, startBold, numbers, content, endBold] = match;
93-
94-
// Capitalize first letter of the content
95-
const processedContent = content.charAt(0).toUpperCase() + content.slice(1);
96-
97-
// Reconstruct the line maintaining original formatting
98-
if (startBold) {
99-
// Only add ** if they were present in the original
100-
return `${hashes} ${startBold}${numbers ? numbers + ". " : ""}${processedContent}${endBold || "**"}`;
101-
} else {
102-
return `${hashes} ${numbers ? numbers + ". " : ""}${processedContent}`;
103-
}
98+
const [_, prefix, firstLetter, rest] = match;
99+
// Only capitalize the first letter, keep everything else exactly as is
100+
return `${prefix}${firstLetter.toUpperCase()}${rest}`;
104101
}
105102

106103
return line;

0 commit comments

Comments
 (0)