From 80b6de9f115c8f47298a9d36424be880638d7725 Mon Sep 17 00:00:00 2001 From: Pushkar Modi <116958355+Pushkar111@users.noreply.github.com> Date: Sat, 13 Dec 2025 16:00:08 +0530 Subject: [PATCH] docs(readme): improve documentation with comprehensive structure - Added About section with project description - Added Table of Contents for easy navigation - Added Repository Structure section - Added Documentation links to all files (KYA, COPYRIGHT, etc.) - Added Usage guide for developers and users - Added Contributing section with guidelines - Added License section - Added Contact section with all social links - Preserved existing branding (logo, badges, social links) - Improved overall organization and professionalism Fixes #1 --- README.md | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 111 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5d456a7..89a9821 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,6 @@ [![Static Badge](https://img.shields.io/badge/Stability-Nexus-228B22?style=for-the-badge&labelColor=FFC517)](https://stability.nexus/) - - @@ -48,6 +46,117 @@

Info

+

Legal and Informational Documents for Stability Nexus Projects

+## 📖 About + +This repository contains essential legal and informational documents used across all **Stability Nexus** projects. These documents ensure transparency, legal compliance, and user awareness for decentralized applications built by The Stable Order. + +## 📑 Table of Contents + +- [About](#-about) +- [Repository Structure](#-repository-structure) +- [Documentation](#-documentation) +- [Usage](#-usage) +- [Contributing](#-contributing) +- [License](#-license) +- [Contact](#-contact) + +## 📂 Repository Structure + +``` +Info/ +├── KYA.md # Know Your Assumptions template +├── COPYRIGHT.md # Copyright notice and usage terms +├── TermsAndConditions.md # Terms and Conditions +├── Licenses/ # License documentation +├── public/ # Public assets (logos, images) +│ └── stability.svg # Stability Nexus logo +└── README.md # This file +``` + +## 📄 Documentation + +### Core Documents + +- **[Know Your Assumptions (KYA)](KYA.md)** - Template displayed on all Stability Nexus UIs to inform users about: + - Smart contract immutability and autonomy + - Blockchain transaction finality + - Serverless frontend architecture + - Risks and responsibilities + - Terms and conditions + +- **[Copyright Information](COPYRIGHT.md)** - Copyright notice and usage terms for all works in this repository + +- **[Terms and Conditions](TermsAndConditions.md)** - Detailed terms and conditions for using Stability Nexus applications + +- **[Licenses](Licenses/)** - License documentation for the project + +### Assets + +- **[Public Assets](public/)** - Contains the Stability Nexus logo and other public resources + +## 🔧 Usage + +### For Developers + +When building a Stability Nexus project, integrate the KYA modal: + +1. Display `KYA.md` content as a modal on first use +2. Add a "KYA" link in the footer that reopens the modal +3. Require user acknowledgment before proceeding + +**Example Implementation:** +- [Benefaction Platform (Ergo)](https://ergo.bene.stability.nexus) +- [Source Code](https://github.com/StabilityNexus/BenefactionPlatform-Ergo) + +### For Users + +These documents inform you about: +- How Stability Nexus applications work +- Your rights and responsibilities +- Risks associated with blockchain applications +- Terms of use + +## 🤝 Contributing + +We welcome contributions to improve our documentation! To contribute: + +1. Fork this repository +2. Create a feature branch (`git checkout -b docs/improve-documentation`) +3. Make your changes +4. Commit with conventional format (`docs: improve KYA template`) +5. Push to your fork +6. Open a Pull Request + +Please ensure: +- Documentation is clear and accurate +- Legal language is reviewed carefully +- Changes align with The Stable Order's mission + +## 📜 License + +All works in this repository may be used according to the conditions stated in the LICENSE.md file available in this repository. + +These works are **WITHOUT ANY WARRANTY**, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + +## 📞 Contact + +- **Website:** [https://stability.nexus](https://stability.nexus) +- **Telegram:** [https://t.me/StabilityNexus](https://t.me/StabilityNexus) +- **Discord:** [https://discord.gg/YzDKeEfWtS](https://discord.gg/YzDKeEfWtS) +- **X (Twitter):** [@StabilityNexus](https://x.com/StabilityNexus) +- **Medium:** [https://news.stability.nexus](https://news.stability.nexus) +- **LinkedIn:** [Stability Nexus](https://linkedin.com/company/stability-nexus) +- **YouTube:** [@StabilityNexus](https://www.youtube.com/@StabilityNexus) + +--- + +
+ © 2025 The Stable Order. + +
+ +

(back to top)