Fix abbreviation casing issues (#254)

gyan-sharma · web-flow · commit 74cba9126fd4 · 2025-03-27T20:48:16.000+05:30
## Summary by Sourcery

Fix abbreviation and casing issues in documentation and code formatting

Enhancements:
- Improved text formatting function to handle markdown and sentence
casing more robustly
- Simplified heading processing logic in formatting script

Documentation:
- Removed cryptic abbreviation placeholders from multiple documentation
files
- Standardized heading capitalization across documentation
- Improved readability of section headings
diff --git a/content/docs/about-settlemint/introduction.mdx b/content/docs/about-settlemint/introduction.mdx
@@ -193,7 +193,7 @@ The **Blockchain Explorer** offers real-time insights into:
   private networks. It relies on fast JSON-RPC and GraphQL queries, making it a
   cornerstone for auditing, diagnostic checks, and compliance reporting.
 
-## **Code studio **abbr_543svb8f5****
+## **Code studio IDE**
 
 A **browser-based IDE** that streamlines contract development for various
 networks:
diff --git a/content/docs/building-with-settlemint/evm-chains-guide/setup-code-studio.mdx b/content/docs/building-with-settlemint/evm-chains-guide/setup-code-studio.mdx
@@ -83,7 +83,7 @@ Smart contract sets allow you to incorporate **business logic** into your
 application by deploying smart contracts that run on the blockchain. You can add
 a smart contract set via different methods as part of your development workflow.
 
-## **abbr_eh7glgd44**ide project structure
+## IDE project structure**
 
 The EVM IDE project structure in code studio is thoughtfully organized to
 support efficient smart contract development, testing, and deployment. Each
@@ -104,7 +104,7 @@ with industry-standard tools like Hardhat, Foundry, and The Graph.
 | `cache_forge/`  | Caching directory for Foundry to speed up compilation and reuse outputs.                          |
 | `node_modules/` | Contains installed npm packages and dependencies used in Hardhat or other JS-based tools.         |
 
-## Code studio**abbr_remh50vdc**task manager
+## Code studio task manager
 
 The code studio IDE task manager acts as a centralized hub for running all
 essential development scripts, giving developers a streamlined way to manage the
diff --git a/content/docs/building-with-settlemint/evm-chains-guide/setup-offchain-database.mdx b/content/docs/building-with-settlemint/evm-chains-guide/setup-offchain-database.mdx
@@ -487,7 +487,7 @@ PGPASSWORD=0c510604a378d348e7ed pg_dump \
   -f ~/Desktop/hasura_backup.sql
 ```
 
-## Taking backup via hasura**abbr_7t7p7n61v**
+## Taking backup via hasura CLI
 
 1. Hasura Database
 2. Hasura Metadata
@@ -560,7 +560,7 @@ To export your entire metadata using the Hasura CLI execute the following
 command in your terminal:
 
 ```
-# In hasura__abbr_39ur0dz6c__
+# In hasura CLI
 hasura metadata export
 ```
 
@@ -575,7 +575,7 @@ metadata on that instance, i.e. you lose any metadata that existed before
 applying.
 
 ```
-# In hasura__abbr_1h8x1pu77__
+# In hasura CLI
 hasura metadata apply
 ```
 
@@ -585,7 +585,7 @@ In some cases, the metadata can be out of sync with the database schema. For
 example, when a new column has been added to a table via an external tool.
 
 ```
-# In hasura__abbr_m5qu5acpt__
+# In hasura CLI
 hasura metadata reload
 ```
 
diff --git a/content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-code-studio.mdx b/content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-code-studio.mdx
@@ -83,7 +83,7 @@ Smart contract sets allow you to incorporate **business logic** into your
 application by deploying smart contracts that run on the blockchain. You can add
 a smart contract set via different methods as part of your development workflow.
 
-## **abbr_0ij4e1pte**ide project structure
+## IDE project structure**
 
 The EVM IDE project structure in code studio is thoughtfully organized to
 support efficient smart contract development, testing, and deployment. Each
@@ -104,7 +104,7 @@ with industry-standard tools like Hardhat, Foundry, and The Graph.
 | `cache_forge/`  | Caching directory for Foundry to speed up compilation and reuse outputs.                          |
 | `node_modules/` | Contains installed npm packages and dependencies used in Hardhat or other JS-based tools.         |
 
-## Code studio**abbr_dqlj90p2u**task manager
+## Code studio task manager
 
 The code studio IDE task manager acts as a centralized hub for running all
 essential development scripts, giving developers a streamlined way to manage the
diff --git a/content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-offchain-database.mdx b/content/docs/building-with-settlemint/hedera-hashgraph-guide/setup-offchain-database.mdx
@@ -487,7 +487,7 @@ PGPASSWORD=0c510604a378d348e7ed pg_dump \
   -f ~/Desktop/hasura_backup.sql
 ```
 
-## Taking backup via hasura**abbr_8jpa69073**
+## Taking backup via hasura CLI
 
 1. Hasura Database
 2. Hasura Metadata
@@ -560,7 +560,7 @@ To export your entire metadata using the Hasura CLI execute the following
 command in your terminal:
 
 ```
-# In hasura__abbr_p7wa6x4nr__
+# In hasura CLI
 hasura metadata export
 ```
 
@@ -575,7 +575,7 @@ metadata on that instance, i.e. you lose any metadata that existed before
 applying.
 
 ```
-# In hasura__abbr_iv30utco7__
+# In hasura CLI
 hasura metadata apply
 ```
 
@@ -585,7 +585,7 @@ In some cases, the metadata can be out of sync with the database schema. For
 example, when a new column has been added to a table via an external tool.
 
 ```
-# In hasura__abbr_cmqcd2sqb__
+# In hasura CLI
 hasura metadata reload
 ```
 
diff --git a/content/docs/building-with-settlemint/hyperledger-fabric-guide/setup-code-studio.mdx b/content/docs/building-with-settlemint/hyperledger-fabric-guide/setup-code-studio.mdx
@@ -78,7 +78,7 @@ Smart contract sets allow you to incorporate **business logic** into your
 application by deploying chaincodes that run on the blockchain. You can add a
 chaincode set via different methods as part of your development workflow.
 
-## Fabric**abbr_9vb9l2s75**project structure
+## Fabric IDE project structure
 
 The Fabric IDE project structure in Code Studio is tailored to support robust
 development and lifecycle management of Hyperledger Fabric chaincode. It
@@ -110,7 +110,7 @@ with automation support, organized in a modular and maintainable layout.
 
 ---
 
-## Code studio**abbr_q7obc13hg**task manager for fabric
+## Code studio task manager for fabric
 
 The **Code Studio Task Manager** for Hyperledger Fabric provides a curated set
 of tasks to manage the full chaincode lifecycle, perform channel operations, and
diff --git a/content/docs/building-with-settlemint/hyperledger-fabric-guide/setup-offchain-database.mdx b/content/docs/building-with-settlemint/hyperledger-fabric-guide/setup-offchain-database.mdx
@@ -487,7 +487,7 @@ PGPASSWORD=0c510604a378d348e7ed pg_dump \
   -f ~/Desktop/hasura_backup.sql
 ```
 
-## Taking backup via hasura**abbr_flprofqzl**
+## Taking backup via hasura CLI
 
 1. Hasura Database
 2. Hasura Metadata
@@ -560,7 +560,7 @@ To export your entire Metadata using the Hasura CLI execute the following
 command in your terminal:
 
 ```
-# In hasura__abbr_e1v88g3fk__
+# In hasura CLI
 hasura metadata export
 ```
 
@@ -575,7 +575,7 @@ Metadata on that instance, i.e. you lose any Metadata that existed before
 applying.
 
 ```
-# In hasura__abbr_7pvp3stmv__
+# In hasura CLI
 hasura metadata apply
 ```
 
@@ -585,7 +585,7 @@ In some cases, the Metadata can be out of sync with the database schema. For
 example, when a new column has been added to a table via an external tool.
 
 ```
-# In hasura__abbr_scgjt6qou__
+# In hasura CLI
 hasura metadata reload
 ```
 
diff --git a/content/docs/knowledge-bank/public-blockchains.mdx b/content/docs/knowledge-bank/public-blockchains.mdx
@@ -659,7 +659,7 @@ reduction) and also changed the economic issuance (no more large block rewards,
 only small issuance to validators and fee burn often exceeds issuance, making
 ETH possibly deflationary at times).
 
-## Smart contract execution: the ethereum virtual machine **abbr_o3y2j9plj**
+## Smart contract execution: the ethereum virtual machine - EVM
 
 One of Ethereum's core innovations is the Ethereum Virtual Machine. The EVM is a
 stack-based virtual CPU that executes contract bytecode. Every Ethereum full
@@ -970,7 +970,7 @@ even before it's submitted, validators consider those blocks final). The
 experience is high-speed, leveraging the trust that validators will behave (due
 to stake at risk).
 
-## State management and**abbr_s1hbpm6mi**compatibility
+## State management and EVM compatibility
 
 The Polygon PoS chain is fully EVM-compatible. It maintains an account-based
 state model nearly identical to Ethereum's:
diff --git a/content/docs/platform-components/blockchain-infrastructure/blockchain-nodes.mdx b/content/docs/platform-components/blockchain-infrastructure/blockchain-nodes.mdx
@@ -240,13 +240,13 @@ Non-validator nodes. All nodes are configured to be archive nodes.
 For hypelerledger fabric, SettleMint offers options between peer and orderer
 nodes.
 
-## **1. hyperledger besu node overview**
+## 1. Hyperledger Besu node overview
 
 The **Besu Node Dashboard** serves as a comprehensive interface for managing and
 monitoring a **Hyperledger Besu node**. It provides insights into node status,
 network connectivity, blockchain interactions, and system performance.
 
-### **1.1 details tab**
+### 1.1 Details tab
 
 ![EVM Node Info](../../../img/platfrom-components/evm-node-info.png)
 
@@ -279,7 +279,7 @@ transactions, and enabling peer-to-peer connectivity**.
 
 ---
 
-### **1.2 connect with node**
+### 1.2 Connect with node
 
 ![EVM Node Connection](../../../img/platfrom-components/evm-node-connection.png)
 
@@ -292,7 +292,7 @@ protocols:
 
 ---
 
-### **1.3 json-rpc**
+### 1.3 JSON-rpc
 
 The **JSON-RPC** interface enables blockchain queries, transactions, and
 debugging.
@@ -359,7 +359,7 @@ debugging.
 
 ---
 
-### **1.4 graphql**
+### 1.4 GraphQL
 
 GraphQL provides an efficient querying method for blockchain data.
 
@@ -372,7 +372,7 @@ GraphQL provides an efficient querying method for blockchain data.
 
 ---
 
-### **1.5 resources**
+### 1.5 Resources
 
 Monitors **CPU, memory, disk usage, and network connections** to optimize
 performance.
@@ -386,7 +386,7 @@ performance.
 
 ---
 
-### **1.6 logs**
+### 1.6 Logs
 
 ![EVM Node Logs](../../../img/platfrom-components/evm-node-logs.png)
 
@@ -398,12 +398,12 @@ Real-time logs provide visibility into **node operations**, including:
 
 ---
 
-## **2. hyperledger fabric node overview**
+## 2. Hyperledger Fabric node overview
 
 The **Hyperledger Fabric Node Dashboard** is designed to monitor and manage
 Fabric nodes, focusing on consensus, network identity, and operational metrics.
 
-### **2.1 details tab**
+### 2.1 details tab
 
 ![Fabric Node Info](../../../img/platfrom-components/fabric-node-info.png)
 
@@ -418,7 +418,7 @@ The **Details** tab provides:
 
 ---
 
-### **2.2 node stats**
+### 2.2 Node stats
 
 Provides critical **consensus and participation metrics**, including:
 
@@ -434,7 +434,7 @@ Provides critical **consensus and participation metrics**, including:
 
 ---
 
-### **2.3 node identity & security**
+### 2.3 Node identity & security
 
 ![Fabric Node Identity](../../../img/platfrom-components/fabric-node-identity.png)
 
@@ -444,15 +444,15 @@ This section contains **cryptographic details** for network security:
 - **Node’s TLS Certificates & Public Keys** – Verifies node identity.
 - **Private Keys & Certificates** – Used for authentication and encryption.
 
-#### **Capabilities:**
+#### Capabilities:
 
 - **Secure Network Communication** – TLS encryption for data integrity.
 - **Node Authentication** – Ensures trusted interactions within Fabric.
 - **Certificate Management** – Maintains cryptographic security.
 
 ---
 
-### **2.4 resources tab**
+### 2.4 Resources tab
 
 Similar to Besu, this tab provides:
 
@@ -462,7 +462,7 @@ Similar to Besu, this tab provides:
 
 ---
 
-### **2.5 logs tab**
+### 2.5 Logs tab
 
 ![Fabric Node Logs](../../../img/platfrom-components/fabric-node-logs.png)
 
diff --git a/content/docs/platform-components/blockchain-infrastructure/insights.mdx b/content/docs/platform-components/blockchain-infrastructure/insights.mdx
@@ -154,7 +154,7 @@ Click an Account address to view:
   All operations require appropriate permissions in your workspace.
 </Callout>
 
-# Blockscout explorer for**abbr_krb5c93ug**chains
+# Blockscout explorer for EVM chains
 
 Blockscout is an open-source blockchain explorer optimized for Ethereum Virtual
 Machine (EVM)-compatible networks. It provides a comprehensive interface for
diff --git a/content/docs/platform-components/dev-tools/ai-code-assistant.mdx b/content/docs/platform-components/dev-tools/ai-code-assistant.mdx
@@ -3,7 +3,7 @@ title: "AI code assistant"
 description: RooCode Assistant
 ---
 
-## __abbr_5a9vytyd0__code assistant
+## AI code assistant
 
 RooCode is an AI-powered coding assistant integrated into SettleMint’s Code
 Studio, replacing the former “AI Genie”. It enhances Code Studio by introducing
diff --git a/content/docs/platform-components/dev-tools/code-studio.mdx b/content/docs/platform-components/dev-tools/code-studio.mdx
@@ -143,7 +143,7 @@ The programming languages for smart contracts differ depending on the protocol:
 
 ---
 
-### Solidity contracts __abbr_tx5wgumuh__
+### Solidity contracts IDE
 
 | Template                                                                                    | Description                               |
 | ------------------------------------------------------------------------------------------- | ----------------------------------------- |
diff --git a/content/docs/platform-components/dev-tools/mcp.mdx b/content/docs/platform-components/dev-tools/mcp.mdx
@@ -3,7 +3,7 @@ title: "MCP"
 description: Using the Model Context Protocol (MCP) to connect LLM to blockchain
 ---
 
-## Introduction to model context protocol **abbr_5g3w2aq2d**
+## Introduction to model context protocol MCP
 
 The Model Context Protocol (MCP) is a framework designed to enhance the
 capabilities of AI agents and large language models (LLMs) by providing
@@ -22,7 +22,7 @@ agents in a consistent way. The result is that AI models can go beyond their
 trained knowledge and interact with live data and real-world applications
 seamlessly.
 
-### Why does**abbr_eogfubb9i**matter?
+### Why does AI matter?
 
 Modern AI models are powerful but traditionally operate as closed systems - they
 generate responses based on patterns learned from training data, without
@@ -227,7 +227,7 @@ independently. For example, if a new blockchain is introduced, you can add a
 connector for it without changing how the AI asks for data. Or if the AI model
 is updated, it can still use the same MCP server and connectors as before.
 
-## Settlemint's implementation of**abbr_bd2z3jq7k**
+## Settlemint's implementation of AI
 
 SettleMint is a leading blockchain integration platform that has adopted and
 implemented MCP to empower AI agents with blockchain intelligence and
@@ -310,7 +310,7 @@ and control accessible to AI in a meaningful way. It effectively makes
 blockchain networks intelligent by allowing AI to continuously monitor and react
 to on-chain events.
 
-### Usage in**abbr_pon2kzalz**and blockchain
+### Usage in AI and blockchain
 
 By combining the strengths of AI and blockchain via MCP, SettleMint unlocks
 several powerful use cases:
@@ -350,7 +350,7 @@ To solidify the understanding, let's look at some concrete examples of how MCP
 can be used in a development workflow and in applications, especially with
 SettleMint's tooling.
 
-### Implementing**abbr_1ali5at9r**in a development workflow
+### Implementing AI in a development workflow
 
 Suppose you are a developer working on a blockchain project, and you want to use
 an AI assistant to help manage your smart contracts. You can integrate MCP into
diff --git a/content/docs/use-case-guides/asset-tokenization.mdx b/content/docs/use-case-guides/asset-tokenization.mdx
@@ -141,7 +141,8 @@ For more information on how to add a smart contract set,
 
 ![Create a Smart Contract](../../img/developer-guides/asset-tokenization/create-empty-smart-contract.png)
 
-### 2. Opening the integrated development environment **abbr_imalqmk3t**
+### 2. Opening the integrated development environment IDE
+
 
 To add and edit the smart contract code, you will use the IDE.
 
diff --git a/format-headings.ts b/format-headings.ts
