4.6 KiB
4.6 KiB
Workspace Documentation Hub
This directory serves as the central documentation hub for all projects in the workspace.
📚 Documentation Index
Project Documentation
Blockchain & DeFi
- 237-combo - DeFi Starter Kit
- 27-combi - Aave Stablecoin Looping Tool
- asle - Ali & Saum Liquidity Engine
- CurrenciCombo - ISO-20022 Combo Flow
- no_five - DBIS Atomic Amortizing Leverage Engine
- quorum-test-network - Quorum Dev Quickstart
- smom-dbis-138 - DeFi Oracle Meta Mainnet
- strategic - TypeScript CLI + Solidity Atomic Executor
Banking & Financial Infrastructure
- dbis_core - DBIS Core Banking System
- dbis_docs - DBIS Institutional Documentation
- the_order - Digital Identity Platform
Cloud Infrastructure & DevOps
- loc_az_hci - Proxmox VE → Azure Arc → Hybrid Cloud Stack
- Sankofa - Sankofa Phoenix Cloud Platform
Web Applications & Platforms
- Datacenter-Control-Complete - Datacenter Control System
- miracles_in_motion - Miracles In Motion Platform
- stinkin_badges - Badge Creation Platform PRO
Gaming & Metaverse
- metaverseDubai - Dubai Metaverse
Monorepositories
- Aseret_Global - Banking & Financial Services Monorepo
- Elemental_Imperium - DBIS Tripartite Body (1/3)
- iccc_monorepo - International Cross-Chain Council
- the_order - Identity & Credential Platform Monorepo
- panda_monorepo - Panda Ecosystem Monorepo
- Defi-Mix-Tooling - DeFi Development Tools Monorepo
Reference Documentation
- Project Structure - Complete monorepo structure overview
- High-Level TODO & Optimization - Strategic roadmap and deployment planning (consolidates deployment requirements)
- DBIS Projects Review - Comprehensive DBIS projects review
- Comprehensive Project Review - Complete project review
- All Tasks Complete - Implementation status and completed tasks
Archived Documentation
- Archive Index - Index of archived documentation
- Deployment Requirements (Archived) - Archived deployment requirements (consolidated into HIGH_LEVEL_TODO_OPTIMIZATION.md)
- Streamlining Recommendations (Archived) - Archived recommendations (all implemented)
📖 Documentation Categories
Architecture
- System architecture documentation
- Infrastructure diagrams
- Design patterns and decisions
Deployment
- Deployment guides
- Infrastructure as Code
- Environment setup
Development
- Development setup guides
- Coding standards
- Testing guidelines
API Documentation
- REST APIs
- GraphQL APIs
- WebSocket APIs
Tutorials
- Getting started guides
- Step-by-step tutorials
- Best practices
🔍 Finding Documentation
By Project
Navigate to the project directory and check its README.md and docs/ folder.
By Category
Use the categories above to find documentation by topic.
By Technology
- Blockchain/Solidity: See DeFi and blockchain projects
- TypeScript/Node.js: See backend and web applications
- React/Next.js: See frontend applications
- Terraform/Kubernetes: See infrastructure projects
📝 Contributing to Documentation
- Follow the README Template
- Update this index when adding new documentation
- Keep documentation up-to-date with code changes
- Use clear, concise language
- Include code examples where helpful
🆘 Getting Help
- Check the project's README.md first
- Review the Comprehensive Project Review
- Check All Tasks Complete for implementation status
- Review High-Level TODO & Optimization for planning
- Check project-specific documentation directories
Last Updated: 2025-01-27