feat: add atk documentation (#191)

## Summary by Sourcery

Adds documentation for the Asset Tokenization Kit contracts, including
Stablecoin, Bond, Fund, Cryptocurrency, and Equity.

Documentation:
- Adds documentation for the Stablecoin contract, detailing its features
such as collateral-backed issuance and role-based controls.
- Adds documentation for the Bond contract, explaining its
collateralized bond issuance, maturity and redemption features.
- Adds documentation for the Fund contract, covering automated fee
management, voting and governance features.
- Adds documentation for the Cryptocurrency contract, describing its
minting and supply management capabilities.
- Adds documentation for the Equity contract, detailing its voting and
governance mechanisms.

Author: roderik

content/docs/building-with-settlemint/kits/asset-tokenization/contracts/bond.mdx

@@ -0,0 +1,85 @@
+---
+title: Bond
+description: Secure, Collateralized Fixed-Income Digital Asset
+---
+
+## Introduction
+
+The Bond is a digital representation of a traditional bond, enabling secure,
+transparent, and efficient fixed-income investments on a blockchain. Every
+issued Bond Token is fully backed by underlying assets, ensuring stability and
+maintaining investor confidence. It provides institutions with robust
+functionalities, including yield distribution, maturity management, asset
+redemption, comprehensive access controls, and compliance mechanisms.
+
+## Why Digital Bonds?
+
+Digital bonds integrate the reliability of traditional financial instruments
+with the flexibility and efficiency of blockchain technology. For banks and
+financial institutions, digital bonds offer streamlined issuance, reduced
+operational costs, improved transparency, and enhanced compliance and auditing
+capabilities.
+
+### Enterprise Applications:
+
+- **Institutional Investments:** Secure, auditable fixed-income investments with
+  clear, blockchain-based issuance and redemption.
+- **Treasury Optimization:** Efficient digital management of fixed-income
+  portfolios.
+- **Settlement Efficiency:** Automate bond settlements, reducing processing time
+  and operational risks.
+- **Liquidity Management:** Enhance liquidity management by easily redeeming
+  bonds and distributing yields.
+
+## Contract Features and Capabilities
+
+### Collateralized Bond Issuance
+
+- Bonds are issued with a fixed face value backed by an underlying ERC20 asset,
+  ensuring secure and transparent value retention.
+
+### Maturity and Redemption
+
+- Bonds have a defined maturity date after which holders can redeem tokens for
+  underlying assets, providing predictable liquidity and return.
+- Redemption can only occur post-maturity, ensuring controlled and predictable
+  lifecycle management.
+
+### Yield Distribution
+
+- Supports regular yield distributions to token holders, leveraging built-in
+  yield mechanisms to automate periodic payments, simplifying asset management.
+
+### Comprehensive Access Control
+
+- **Supply Management Role:** Authority to mint tokens, manage supply, and
+  oversee collateral to ensure compliance with financial regulations.
+- **User Management Role:** Manages user permissions, including account
+  blocking, ensuring regulatory compliance and security.
+- **Admin Role:** Controls key functionalities like pausing transfers and token
+  operations during regulatory actions or emergencies.
+
+### Security and Regulatory Compliance
+
+- **Pause and Unpause Functionality:** Allows controlled suspension of token
+  transfers, ensuring compliance and response capabilities in critical
+  situations.
+- **Blocklist Functionality:** Facilitates user blocking/unblocking for AML/KYC
+  compliance.
+
+### Meta-Transaction Support
+
+- Implements ERC2771, enabling third-party payment of gas fees, improving
+  accessibility and ease-of-use for institutional stakeholders.
+
+### Transparent Yield Distribution and Auditing
+
+- Integrated historical balance tracking ensures clear and transparent yield
+  calculations and distributions.
+- Detailed event logging provides comprehensive records for auditing, enhancing
+  regulatory compliance and investor confidence.
+
+## Conclusion
+
+Bond empowers financial institutions to modernize fixed-income management
+securely, efficiently, and compliantly through advanced blockchain technology.

content/docs/building-with-settlemint/kits/asset-tokenization/contracts/cryptocurrency.mdx

@@ -0,0 +1,72 @@
+---
+title: CryptoCurrency
+description: Reliable and Customizable Digital Asset
+---
+
+## Introduction
+
+The CryptoCurrency contract provides a secure and customizable ERC20 token
+designed to meet the rigorous needs of financial institutions and enterprises.
+It includes advanced role-based access control, robust minting capabilities, and
+built-in support for meta-transactions, ensuring security, usability, and
+compliance. With features tailored for institutional-grade management, it
+simplifies digital asset issuance, administration, and operational oversight.
+
+## Why Use Digital Tokens?
+
+Digital tokens like CryptoCurrency empower enterprises and financial
+institutions by providing efficient, transparent, and secure asset management
+solutions. They streamline transactions, enhance compliance, and reduce costs
+associated with traditional financial processes.
+
+### Enterprise Applications:
+
+- **Institutional Asset Management:** Efficiently manage and track institutional
+  funds.
+- **Corporate Payments:** Enable swift and transparent payments across global
+  operations.
+- **Loyalty and Reward Programs:** Digitally manage loyalty points or rewards
+  securely and transparently.
+- **Supply Chain Finance:** Facilitate smooth payments and settlements across
+  supply chain networks.
+
+## Contract Features and Capabilities
+
+### Minting and Supply Management
+
+- Authorized roles control token issuance, allowing enterprises precise
+  management of token supply in compliance with financial regulations.
+- Tokens can be minted dynamically, enabling flexibility in response to
+  operational demands.
+
+### Robust Role-Based Controls
+
+- **Supply Management Role:** Manages token minting, providing secure control
+  over asset issuance.
+- **Admin Role:** Has comprehensive governance capabilities, including emergency
+  interventions, administrative operations, and token security oversight.
+
+### Security and Regulatory Compliance
+
+- Built-in access control ensures only authorized personnel perform critical
+  operations, significantly enhancing security and regulatory adherence.
+- Supports safe withdrawal of mistakenly sent ERC20 tokens, safeguarding asset
+  integrity.
+
+### Meta-Transaction Capability
+
+- Integrates ERC2771 to allow transactions to be relayed by third parties,
+  significantly improving accessibility and user experience by enabling gasless
+  transactions for end-users.
+
+### Customizable Token Parameters
+
+- Token details such as decimals, initial supply, and token naming are
+  configurable at deployment, offering adaptability to diverse enterprise
+  requirements.
+
+## Conclusion
+
+CryptoCurrency ensures enterprises and financial institutions manage digital
+assets securely, efficiently, and in alignment with regulatory requirements,
+empowering a new level of financial innovation and operational excellence.

content/docs/building-with-settlemint/kits/asset-tokenization/contracts/equity.mdx

@@ -0,0 +1,72 @@
+---
+title: Equity
+description: Institutional-Grade Digital Equity Management
+---
+
+## Introduction
+
+The Equity is a robust, ERC20-compatible security token designed for managing
+equity ownership digitally. Tailored specifically for banks, corporations, and
+institutional investors, this contract facilitates secure, transparent equity
+issuance with advanced governance features, including voting rights, role-based
+administration, compliance mechanisms, and support for meta-transactions.
+
+## Why Digital Equity Tokens?
+
+Digital Equity Tokens modernize traditional equity management by combining
+blockchain transparency with stringent institutional requirements. They
+streamline equity administration, enhance governance through digital voting, and
+significantly simplify regulatory compliance and reporting.
+
+### Enterprise Applications:
+
+- **Equity Issuance and Management:** Digitally issue and manage different
+  equity classes and categories efficiently.
+- **Investor Voting and Governance:** Facilitate transparent and secure
+  shareholder voting, ensuring robust corporate governance.
+- **Regulatory Compliance:** Leverage built-in compliance and access control
+  mechanisms to adhere strictly to regulatory standards.
+- **Institutional Transparency:** Enhance transparency and auditability of
+  equity holdings and transfers.
+
+## Contract Features and Capabilities
+
+### Voting and Governance
+
+- Implements advanced voting mechanisms via ERC20Votes, enabling digital
+  shareholder voting and governance participation.
+- Transparent tracking of voting power ensures accurate governance outcomes.
+
+### Robust Role-Based Access Control
+
+- **Supply Management Role:** Authorized roles manage equity token issuance,
+  ensuring secure and compliant control over the equity supply.
+- **User Management Role:** Administers critical user operations such as
+  blocking or unblocking addresses, enhancing security and compliance.
+- **Administrator Role:** Holds comprehensive operational oversight, including
+  emergency pausing and critical token security actions.
+
+### Security and Compliance
+
+- **Pause Functionality:** Allows administrators to suspend operations during
+  audits, regulatory interventions, or emergencies.
+- **Blocklist Capability:** Supports regulatory compliance with built-in
+  mechanisms to manage and restrict token access for specific users.
+
+### Meta-Transaction Support
+
+- Implements ERC2771 to facilitate transactions via third-party relayers,
+  enabling user-friendly, gasless transactions essential for institutional
+  users.
+
+### Customizable Equity Classes and Categories
+
+- Equity types and categories (e.g., Common, Preferred, Series A, Seed) can be
+  clearly defined at deployment, providing flexibility aligned with enterprise
+  requirements.
+
+## Conclusion
+
+Equity empowers institutions with advanced digital equity management tools that
+streamline issuance, governance, and compliance, significantly enhancing
+transparency, security, and operational efficiency.

content/docs/building-with-settlemint/kits/asset-tokenization/contracts/fund.mdx

@@ -0,0 +1,84 @@
+---
+title: Fund
+description: Institutional-Grade Digital Fund Management
+---
+
+## Introduction
+
+The Fund is an advanced ERC20-compliant security token tailored explicitly for
+financial institutions managing digital investment funds. It integrates
+sophisticated features such as management fee collection, secure governance with
+voting capabilities, robust role-based access control, and compliance-focused
+functionalities, enabling transparent, efficient, and secure management of
+digital investment vehicles.
+
+## Why Digital Fund Tokens?
+
+Digital Fund Tokens significantly enhance traditional fund management by
+leveraging blockchain technology to provide transparency, reduce administrative
+overhead, simplify fee management, and enforce stringent compliance standards.
+They offer institutions clear visibility, efficient operational controls, and
+streamlined governance.
+
+### Enterprise Applications:
+
+- **Investment Fund Management:** Efficiently manage shares in mutual funds,
+  hedge funds, and other investment vehicles digitally.
+- **Fee Automation:** Automate calculation and collection of management and
+  performance fees, simplifying fund administration.
+- **Corporate Governance:** Enhance governance through integrated voting
+  mechanisms, providing transparent shareholder participation.
+- **Regulatory Compliance:** Strengthen regulatory adherence through built-in
+  compliance and blocklist capabilities.
+
+---
+
+## Contract Features and Capabilities
+
+### Automated Fee Management
+
+- Automatically calculates and collects management fees based on assets under
+  management (AUM) and time elapsed, ensuring consistent and transparent fee
+  distribution.
+
+### Voting and Governance
+
+- Integrated ERC20Votes functionality ensures secure, transparent, and auditable
+  shareholder voting and decision-making processes.
+- Accurate tracking of voting power enables effective governance and enhances
+  investor trust.
+
+### Role-Based Access Control
+
+- **Supply Management Role:** Controls token issuance and withdrawal of
+  mistakenly sent assets, ensuring precise oversight of the fund’s financial
+  operations.
+- **User Management Role:** Manages critical compliance operations, including
+  user blocking/unblocking to maintain regulatory standards.
+- **Administrator Role:** Comprehensive control over key functionalities, such
+  as pausing transfers during compliance audits or emergencies.
+
+### Security and Compliance
+
+- **Pause Capability:** Allows temporary suspension of operations, enhancing
+  security during audits or in response to regulatory requirements.
+- **Blocklist Functionality:** Implements compliance-focused mechanisms to
+  restrict or permit specific user interactions effectively.
+
+### Meta-Transaction Support
+
+- Implements ERC2771, enabling third-party relayed transactions to simplify and
+  enhance user interactions by allowing gas-free transactions for investors and
+  institutional stakeholders.
+
+### Customizable Fund Attributes
+
+- Define fund classes (e.g., Hedge Fund, Mutual Fund) and categories (e.g.,
+  Long/Short Equity, Global Macro) at deployment, offering flexibility aligned
+  with distinct institutional needs.
+
+## Conclusion
+
+Fund equips financial institutions with the tools to seamlessly digitize fund
+operations, enforce strong governance standards, and ensure comprehensive
+regulatory compliance in an efficient and transparent manner.