binbash Leverage™ Documentation

Overview

This repository contains the comprehensive documentation for binbash Leverage™, an enterprise-grade AWS infrastructure-as-code ecosystem that accelerates cloud deployment by up to 10x.

Live Documentation: leverage.binbash.co

What is Leverage?

Leverage is a complete AWS cloud infrastructure framework consisting of:

• 🏗️ Reference Architecture: Production-ready, multi-account AWS infrastructure following AWS Well-Architected Framework
• 📚 Infrastructure Library: 50+ Terraform/OpenTofu modules covering all AWS services
• ⚡ CLI Tool: Python-based orchestration tool for infrastructure lifecycle management

🚀 Getting Started

Documentation Structure

The documentation covers everything you need to know about Leverage:

• Concepts: Core principles and architecture overview
• Try Leverage: Step-by-step tutorial to deploy your first AWS infrastructure
• User Guide: Comprehensive implementation guides for all components
• How It Works: Deep dives into architecture and design decisions
• Work With Us: Community, support, and contribution information

Repository Structure

• master branch: Documentation source code (Markdown files)
• gh-pages branch: Auto-deployed documentation site
• docs/: All documentation content organized by topic
• material/: Custom MkDocs Material theme overrides
• mkdocs.yml: Site configuration and navigation structure

🤝 Contributing

We welcome contributions to improve the documentation and the entire binbash Leverage ecosystem!

Contributing to Documentation

1. Fork this repository
2. Clone your fork and set up the development environment:

   git clone https://github.com/YOUR_USERNAME/le-ref-architecture-doc.git
   cd le-ref-architecture-doc
   make init-makefiles  # First time only
   make docs-live       # Visit http://localhost:8000

3. Make your changes and test locally
4. Submit a pull request with clear description

Contributing to Other Leverage Projects

Interested in contributing to the broader Leverage ecosystem?

• Reference Architecture: AWS infrastructure code
• CLI Tool: Command-line interface
• Terraform Modules: 50+ AWS modules

Detailed Guidelines: See our Contributing Guide for documentation-specific guidelines, or visit our comprehensive contributing guide for all projects.

🛠️ Development

Technology Stack

• Documentation Generator: MkDocs Material
• Development Environment: Docker-based for consistency
• Auto-Deployment: CircleCI pipeline to GitHub Pages
• Theme: Custom Material theme with binbash branding

Available Commands

make help                    # Show all available commands
make init-makefiles         # Initialize external makefile dependencies
make docs-live              # Start local development server
make docs-deploy-gh         # Deploy to GitHub Pages
make docs-check-dead-links  # Validate all links (requires GNU tools)

Diagrams and Assets

• Editable Diagrams: Located in docs/assets/diagrams/editable/ (DrawIO format)
• Static Images: Exported diagrams and screenshots in docs/assets/images/
• Logos: Brand assets in docs/assets/images/logos/

📞 Support

• Documentation: leverage.binbash.co
• Community: GitHub Discussions
• Issues: Report bugs or request features
• Contact: [email protected]

📄 License

Copyright © 2017-2025 binbash. This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

---

Made with ❤️ by the binbash team