Skip to content

Commit 7fe4158

Browse files
gyan-sharmainsider89saeeddawodbl0upSaeeDawod
authored
Platform documentation upgrade (#252)
Platform documentation upgrade March 2025 ## Summary by Sourcery Perform a comprehensive documentation style and formatting update across multiple markdown files in the SettleMint documentation repository. The changes focus on consistent capitalization, title formatting, and minor text refinements while maintaining the original content's intent. Documentation: - Updated documentation files to use consistent title casing and formatting - Standardized capitalization in headings and section titles - Refined text to improve readability and consistency Chores: - Removed unnecessary keyword sections at the end of some files - Cleaned up whitespace and formatting across multiple documentation files --------- Co-authored-by: Oleksandr Hrab <oleksandr@settlemint.com> Co-authored-by: saeeddawod <saeed.dawod@gmail.com> Co-authored-by: bl0up <ambroise.m2@gmail.com> Co-authored-by: SaeeDawod <122533407+SaeeDawod@users.noreply.github.com>
1 parent c777f26 commit 7fe4158

File tree

168 files changed

+8626
-3400
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

168 files changed

+8626
-3400
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
.contentlayer
66
.content-collections
77
.source
8+
.docusaurus
89

910
# test & build
1011
/coverage

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,11 @@
1919
<a href="https://github.com/settlemint/docs/issues">Issues</a>
2020
<br />
2121
</div>
22+
23+
24+
To generate sitemap
25+
26+
```
27+
bun add -d globby prettier
28+
```
29+

bun.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@
453453

454454
"@types/estree": ["@types/estree@1.0.6", "", {}, "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw=="],
455455

456-
"@types/estree-jsx": ["@types/estree-jsx@1.0.5", "", { "dependencies": { "@types/estree": "*" } }, "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg=="],
456+
"@types/estree-jsx": ["@types/estree-jsx@1.0.5", "", { "dependencies": { "@types/estree": "*" } }, "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSDKuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg=="],
457457

458458
"@types/geojson": ["@types/geojson@7946.0.16", "", {}, "sha512-6C8nqWur3j98U6+lXDfTUWIfgvZU+EumvpHKcYjujKH7woYyLj2sUmff0tRhrqM7BohUw7Pz3ZB1jj2gW9Fvmg=="],
459459

content/docs/about-settlemint/introduction.mdx

Lines changed: 83 additions & 54 deletions
Large diffs are not rendered by default.

content/docs/application-kits/asset-tokenization/asset-tokenization-kit.mdx

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Asset Tokenization Kit
2+
title: "Asset tokenization kit"
33
description: Build your digital assets platform in minutes
44
---
55

@@ -11,10 +11,10 @@ import { Card } from "fumadocs-ui/components/card";
1111
The **SettleMint Asset Tokenization Kit** is a complete development toolkit and reference application for launching digital asset platforms quickly and securely. It eliminates the usual complexity of building from scratch by offering a pre-integrated stack of smart contracts, backend services, and a web-based user interface. Whether issuing stablecoins, tokenized securities, or loyalty points, the kit equips developers with all the core components needed to move from idea to prototype in days.
1212

1313

14-
![Asset Tokenization Kit](../../../img/application-kits/asset-tokenization-dashboard.webp)
14+
![Asset Tokenization Kit](../../../img/application-kits/atk-dashboard.png)
1515

1616

17-
## Core Components
17+
## Core components
1818

1919
The kit’s foundation lies in **battle-tested smart contract templates** that follow standards like ERC-20. These templates are extensible and suitable for multiple asset classes:
2020

@@ -33,7 +33,7 @@ Because the backend and frontend layers are already wired together, teams can fo
3333

3434
---
3535

36-
## Compliance and Security
36+
## Compliance and security
3737

3838
Compliance is not an add-on but an embedded principle in the kit’s architecture. It is built to align with enterprise-grade regulatory expectations, supporting both internal governance and external obligations.
3939

@@ -49,7 +49,7 @@ It also supports alignment with evolving regulations such as **Europe’s MiCA**
4949

5050
---
5151

52-
## Operational Monitoring
52+
## Operational monitoring
5353

5454
Institutions need visibility into their asset operations, and the kit offers this out of the box.
5555

@@ -63,29 +63,31 @@ This monitoring framework helps organizations maintain transparency and enforce
6363

6464
---
6565

66-
## Developer Enablement
66+
## Developer enablement
6767

6868
Developers are not left to glue components together manually. The Asset Tokenization Kit ensures all layers work in harmony and offers powerful tools to accelerate custom development.
6969

70-
### Integrated Tools
70+
### Integrated tools
7171
- **SettleMint SDK and CLI** to scaffold, manage, and deploy projects
7272
- **Web-based IDE** for instant cloud development
7373
- **Local dev compatibility** with Git access for use with any code editor
7474

75-
### Pre-Built Blockchain Integrations
75+
### Pre-built blockchain integrations
7676
- **IPFS** for decentralized document and metadata storage
7777
- **The Graph** for indexing on-chain data
7878
- **Hasura** for GraphQL API access to blockchain data
7979

80-
### External Connectivity
80+
### External connectivity
8181
- REST and GraphQL APIs to connect with CRMs, core banking systems, and reporting platforms
8282
- Hooks and webhooks to automate workflows or trigger third-party actions
8383

84+
![Asset Tokenization Kit APIs](../../../img/application-kits/atk-apis.png)
85+
8486
This results in a developer experience where the focus is on building business-specific logic, not plumbing infrastructure.
8587

8688
---
8789

88-
## Deployment and Automation
90+
## Deployment and automation
8991

9092
Launching environments with the kit is straightforward and scalable. Most setup steps are automated and repeatable across development, testing, and production.
9193

@@ -98,7 +100,7 @@ With minimal DevOps overhead, organizations will maintain faster iteration cycle
98100

99101
---
100102

101-
## Speed and Efficiency Gains
103+
## Speed and efficiency gains
102104

103105
Adopting the kit significantly reduces project timelines and developer workload. Organizations will benefit from:
104106

@@ -111,7 +113,7 @@ Development teams no longer need to reinvent the wheel, and product teams can va
111113

112114
---
113115

114-
## Customization and Extensibility
116+
## Customization and extensibility
115117

116118
Unlike rigid SaaS platforms, the kit offers complete flexibility. Every component is open and editable:
117119

@@ -124,7 +126,7 @@ This extensibility ensures that the kit remains relevant as use cases evolve, ma
124126

125127
---
126128

127-
## Ideal Use Cases
129+
## Ideal use cases
128130

129131
The Asset Tokenization Kit is well-suited for:
130132

@@ -137,7 +139,7 @@ Its flexibility and compliance-focused design allow it to operate in diverse ind
137139

138140
---
139141

140-
## Getting Started
142+
## Getting started
141143

142144
To begin using the kit:
143145

@@ -146,11 +148,13 @@ To begin using the kit:
146148
3. **Launch the Web IDE** or integrate into your local development environment
147149
4. **Review documentation and API references** to begin customizing the application
148150

151+
![Asset Tokenization Kit Code](../../../img/application-kits/atk-code.png)
152+
149153
Comprehensive guides, code samples, and pre-configured environments are available to reduce onboarding time for development teams.
150154

151155
---
152156

153-
## Ongoing Support and Roadmap
157+
## Ongoing support and roadmap
154158

155159
- The kit is **actively maintained** and updated to meet new technical and regulatory requirements
156160
- **Support channels** are available for both developer troubleshooting and enterprise onboarding

content/docs/application-kits/asset-tokenization/contracts/bond.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Bond
2+
title: "Bond"
33
description: Secure, Collateralized Fixed-Income Digital Asset
44
---
55

@@ -12,15 +12,15 @@ maintaining investor confidence. It provides institutions with robust
1212
functionalities, including yield distribution, maturity management, asset
1313
redemption, comprehensive access controls, and compliance mechanisms.
1414

15-
## Why Digital Bonds?
15+
## Why digital bonds?
1616

1717
Digital bonds integrate the reliability of traditional financial instruments
1818
with the flexibility and efficiency of blockchain technology. For banks and
1919
financial institutions, digital bonds offer streamlined issuance, reduced
2020
operational costs, improved transparency, and enhanced compliance and auditing
2121
capabilities.
2222

23-
### Enterprise Applications:
23+
### Enterprise applications:
2424

2525
- **Institutional Investments:** Secure, auditable fixed-income investments with
2626
clear, blockchain-based issuance and redemption.
@@ -31,26 +31,26 @@ capabilities.
3131
- **Liquidity Management:** Enhance liquidity management by easily redeeming
3232
bonds and distributing yields.
3333

34-
## Contract Features and Capabilities
34+
## Contract features and capabilities
3535

36-
### Collateralized Bond Issuance
36+
### Collateralized bond issuance
3737

3838
- Bonds are issued with a fixed face value backed by an underlying ERC20 asset,
3939
ensuring secure and transparent value retention.
4040

41-
### Maturity and Redemption
41+
### Maturity and redemption
4242

4343
- Bonds have a defined maturity date after which holders can redeem tokens for
4444
underlying assets, providing predictable liquidity and return.
4545
- Redemption can only occur post-maturity, ensuring controlled and predictable
4646
lifecycle management.
4747

48-
### Yield Distribution
48+
### Yield distribution
4949

5050
- Supports regular yield distributions to token holders, leveraging built-in
5151
yield mechanisms to automate periodic payments, simplifying asset management.
5252

53-
### Comprehensive Access Control
53+
### Comprehensive access control
5454

5555
- **Supply Management Role:** Authority to mint tokens, manage supply, and
5656
oversee collateral to ensure compliance with financial regulations.
@@ -59,20 +59,20 @@ capabilities.
5959
- **Admin Role:** Controls key functionalities like pausing transfers and token
6060
operations during regulatory actions or emergencies.
6161

62-
### Security and Regulatory Compliance
62+
### Security and regulatory compliance
6363

6464
- **Pause and Unpause Functionality:** Allows controlled suspension of token
6565
transfers, ensuring compliance and response capabilities in critical
6666
situations.
6767
- **Blocklist Functionality:** Facilitates user blocking/unblocking for AML/KYC
6868
compliance.
6969

70-
### Meta-Transaction Support
70+
### Meta-transaction support
7171

7272
- Implements ERC2771, enabling third-party payment of gas fees, improving
7373
accessibility and ease-of-use for institutional stakeholders.
7474

75-
### Transparent Yield Distribution and Auditing
75+
### Transparent yield distribution and auditing
7676

7777
- Integrated historical balance tracking ensures clear and transparent yield
7878
calculations and distributions.

content/docs/application-kits/asset-tokenization/contracts/cryptocurrency.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: CryptoCurrency
2+
title: "Cryptocurrency"
33
description: Reliable and Customizable Digital Asset
44
---
55

@@ -12,14 +12,14 @@ built-in support for meta-transactions, ensuring security, usability, and
1212
compliance. With features tailored for institutional-grade management, it
1313
simplifies digital asset issuance, administration, and operational oversight.
1414

15-
## Why Use Digital Tokens?
15+
## Why use digital tokens?
1616

1717
Digital tokens like CryptoCurrency empower enterprises and financial
1818
institutions by providing efficient, transparent, and secure asset management
1919
solutions. They streamline transactions, enhance compliance, and reduce costs
2020
associated with traditional financial processes.
2121

22-
### Enterprise Applications:
22+
### Enterprise applications:
2323

2424
- **Institutional Asset Management:** Efficiently manage and track institutional
2525
funds.
@@ -30,36 +30,36 @@ associated with traditional financial processes.
3030
- **Supply Chain Finance:** Facilitate smooth payments and settlements across
3131
supply chain networks.
3232

33-
## Contract Features and Capabilities
33+
## Contract features and capabilities
3434

35-
### Minting and Supply Management
35+
### Minting and supply management
3636

3737
- Authorized roles control token issuance, allowing enterprises precise
3838
management of token supply in compliance with financial regulations.
3939
- Tokens can be minted dynamically, enabling flexibility in response to
4040
operational demands.
4141

42-
### Robust Role-Based Controls
42+
### Robust role-based controls
4343

4444
- **Supply Management Role:** Manages token minting, providing secure control
4545
over asset issuance.
4646
- **Admin Role:** Has comprehensive governance capabilities, including emergency
4747
interventions, administrative operations, and token security oversight.
4848

49-
### Security and Regulatory Compliance
49+
### Security and regulatory compliance
5050

5151
- Built-in access control ensures only authorized personnel perform critical
5252
operations, significantly enhancing security and regulatory adherence.
5353
- Supports safe withdrawal of mistakenly sent ERC20 tokens, safeguarding asset
5454
integrity.
5555

56-
### Meta-Transaction Capability
56+
### Meta-transaction capability
5757

5858
- Integrates ERC2771 to allow transactions to be relayed by third parties,
5959
significantly improving accessibility and user experience by enabling gasless
6060
transactions for end-users.
6161

62-
### Customizable Token Parameters
62+
### Customizable token parameters
6363

6464
- Token details such as decimals, initial supply, and token naming are
6565
configurable at deployment, offering adaptability to diverse enterprise

content/docs/application-kits/asset-tokenization/contracts/equity.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Equity
2+
title: "Equity"
33
description: Institutional-Grade Digital Equity Management
44
---
55

@@ -11,14 +11,14 @@ institutional investors, this contract facilitates secure, transparent equity
1111
issuance with advanced governance features, including voting rights, role-based
1212
administration, compliance mechanisms, and support for meta-transactions.
1313

14-
## Why Digital Equity Tokens?
14+
## Why digital equity tokens?
1515

1616
Digital Equity Tokens modernize traditional equity management by combining
1717
blockchain transparency with stringent institutional requirements. They
1818
streamline equity administration, enhance governance through digital voting, and
1919
significantly simplify regulatory compliance and reporting.
2020

21-
### Enterprise Applications:
21+
### Enterprise applications:
2222

2323
- **Equity Issuance and Management:** Digitally issue and manage different
2424
equity classes and categories efficiently.
@@ -29,15 +29,15 @@ significantly simplify regulatory compliance and reporting.
2929
- **Institutional Transparency:** Enhance transparency and auditability of
3030
equity holdings and transfers.
3131

32-
## Contract Features and Capabilities
32+
## Contract features and capabilities
3333

34-
### Voting and Governance
34+
### Voting and governance
3535

3636
- Implements advanced voting mechanisms via ERC20Votes, enabling digital
3737
shareholder voting and governance participation.
3838
- Transparent tracking of voting power ensures accurate governance outcomes.
3939

40-
### Robust Role-Based Access Control
40+
### Robust role-based access control
4141

4242
- **Supply Management Role:** Authorized roles manage equity token issuance,
4343
ensuring secure and compliant control over the equity supply.
@@ -46,20 +46,20 @@ significantly simplify regulatory compliance and reporting.
4646
- **Administrator Role:** Holds comprehensive operational oversight, including
4747
emergency pausing and critical token security actions.
4848

49-
### Security and Compliance
49+
### Security and compliance
5050

5151
- **Pause Functionality:** Allows administrators to suspend operations during
5252
audits, regulatory interventions, or emergencies.
5353
- **Blocklist Capability:** Supports regulatory compliance with built-in
5454
mechanisms to manage and restrict token access for specific users.
5555

56-
### Meta-Transaction Support
56+
### Meta-transaction support
5757

5858
- Implements ERC2771 to facilitate transactions via third-party relayers,
5959
enabling user-friendly, gasless transactions essential for institutional
6060
users.
6161

62-
### Customizable Equity Classes and Categories
62+
### Customizable equity classes and categories
6363

6464
- Equity types and categories (e.g., Common, Preferred, Series A, Seed) can be
6565
clearly defined at deployment, providing flexibility aligned with enterprise

0 commit comments

Comments
 (0)