Documentation Index

Welcome to the Bitcoin Yield Copilot documentation.

Getting Started

• README - Project overview
• DEPLOYMENT.md - Deployment guide
• CONTRIBUTING.md - Contribution guide

Architecture

• ARCHITECTURE.md - System architecture
• BOT.md - Telegram bot module
• AGENT.md - AI agent module

Development

• API.md - REST API documentation
• PROTOCOLS.md - DeFi protocol integrations
• UTILS.md - Utilities and configuration
• CONTRACTS.md - Clarity smart contracts
• X402.md - x402 payment integration

Security

• SECURITY.md - Security considerations
• SECURITY_AUDIT.md - Security audit report

Additional

• Implementation.md - Implementation details
• PLAN-MVP-TESTNET.md - MVP plan
• TEST_REPORT.md - Smart contracts test report

Quick Links

• GitHub Repository
• Stacks Documentation
• Telegram Bot API