mirror of
https://github.com/A6-9V/MQL5-Google-Onedrive.git
synced 2026-04-11 09:30:59 +00:00
3180612581
- Add clear project header with badges - Add table of contents with all sections - Add Quick Start section for new users - Fix inconsistent NotebookLM links - Remove placeholder API keys and replace with security notice - Fix contact information - Improve project links section - Reorganize and enhance docs/INDEX.md - Add navigation and search tips to documentation Co-authored-by: Mouy-leng <199350297+Mouy-leng@users.noreply.github.com>
175 lines
6.6 KiB
Markdown
175 lines
6.6 KiB
Markdown
# Documentation Index
|
||
|
||
**Welcome to the MQL5 Trading Automation documentation!**
|
||
|
||
This index provides a structured overview of all documentation available in this repository. For a quick start, see the [main README](../README.md).
|
||
|
||
## 📋 Quick Navigation
|
||
|
||
- [🚀 Getting Started](#-getting-started--environment-setup)
|
||
- [📚 Development & Contributing](#-development--contributing)
|
||
- [☁️ Deployment](#️-deployment)
|
||
- [🤖 Automation & Operations](#-automation--operations)
|
||
- [📈 Trading & Strategy](#-trading--strategy)
|
||
- [🔒 Security & Secrets](#-security--secrets)
|
||
- [📊 CI/CD & Workflows](#-cicd--workflows)
|
||
- [📊 Reports & Analysis](#-reports--analysis)
|
||
- [🌐 Web & UI](#-web--ui)
|
||
- [📖 GitHub Features](#-github-features--best-practices)
|
||
|
||
---
|
||
|
||
## 🚀 Getting Started & Environment Setup
|
||
|
||
**New to the project? Start here!**
|
||
|
||
- [**Quick Start Automation**](Quick_Start_Automation.md) - ⚡ Rapid setup guide for automation
|
||
- [**Exness Deployment Guide**](Exness_Deployment_Guide.md) - 📊 Install MT5 indicators and EAs
|
||
- [**Cloud Deployment Guide**](Cloud_Deployment_Guide.md) - ☁️ Deploy to Render, Railway, Fly.io
|
||
- [**Startup Automation Guide**](Startup_Automation_Guide.md) - 🤖 Auto-start on Windows/Linux
|
||
|
||
**Development Environment Setup:**
|
||
|
||
- [Docker CLI Setup](Docker_CLI_setup.md) - Setting up Docker
|
||
- [GitHub CLI Setup](GitHub_CLI_setup.md) - Setting up `gh` CLI
|
||
- [Cursor CLI Setup](Cursor_CLI_setup.md) - Setting up Cursor IDE
|
||
- [Firebase CLI Setup](Firebase_CLI_setup.md) - Setting up Firebase tools
|
||
|
||
**AI Tools Setup:**
|
||
|
||
- [Jules CLI Setup](Jules_CLI_setup.md) - Installing the Jules agent tools
|
||
- [Jules Execution Guide](Jules_Execution_Guide.md) - Guide for running Jules
|
||
- [Gemini CLI Setup](Gemini_CLI_setup.md) - Installing Gemini agent tools
|
||
|
||
---
|
||
|
||
## 📚 Development & Contributing
|
||
|
||
**Contributing to the project:**
|
||
|
||
- [**Contributing Guidelines**](../CONTRIBUTING.md) - 🤝 How to contribute
|
||
- [**Repository Links**](../REPOSITORY_LINKS.md) - 🔗 All related repositories
|
||
- [**Project Timeline**](../TIMELINE.md) - 📅 Project history
|
||
- [Mouy-leng Request Guide](Mouy-leng_Request_Guide.md) - Procedures for requests
|
||
|
||
---
|
||
|
||
## ☁️ Deployment
|
||
|
||
**Deploy your trading system to the cloud:**
|
||
|
||
- [**Cloud Deployment Guide**](Cloud_Deployment_Guide.md) - ☁️ Multi-platform deployment
|
||
- [**Exness Deployment Guide**](Exness_Deployment_Guide.md) - 📊 MT5 installation
|
||
- [**VPS Setup Guide**](VPS_SETUP_GUIDE.md) - 🖥️ Virtual Private Server setup
|
||
- [**VPS Migration Steps**](VPS_MIGRATION_STEPS.md) - 📦 Migrate between VPS
|
||
- [**WSL and VPS Deployment**](WSL_AND_VPS_DEPLOYMENT.md) - 🐧 Linux deployment
|
||
- [Release Process](RELEASE_PROCESS.md) - Creating and managing releases
|
||
- [Kubernetes Introduction](KUBERNETES_INTRODUCTION.md) - Container orchestration
|
||
- [DEV Container Setup](DEV_CONTAINER_SETUP.md) - DevContainer configuration
|
||
|
||
---
|
||
|
||
## 🤖 Automation & Operations
|
||
|
||
**Automate your trading system:**
|
||
|
||
- [**Startup Automation Guide**](Startup_Automation_Guide.md) - 🚀 Comprehensive automation guide
|
||
- [**Quick Start Automation**](Quick_Start_Automation.md) - ⚡ Quick automation setup
|
||
- [**Windows Task Scheduler Setup**](Windows_Task_Scheduler_Setup.md) - ⏰ Windows auto-start
|
||
- [GitHub Sync Status](GitHub_Sync_Status.md) - OneDrive/GitHub synchronization
|
||
|
||
---
|
||
|
||
## 📈 Trading & Strategy
|
||
|
||
**Expert Advisors and trading strategies:**
|
||
|
||
- [**EA Improvements**](EA_IMPROVEMENTS.md) - 📈 Expert Advisor enhancements
|
||
- [**ExpertMAPSAR Tuning Guide**](ExpertMAPSAR_Tuning_Guide.md) - 🎯 MAPSAR optimization
|
||
- [**Scalping Strategy**](SCALPING_STRATEGY.md) - 💹 Scalping approach
|
||
- [ZOLO Plugin Integration](ZOLO_Plugin_Integration.md) - 🔌 Bridge integration
|
||
- [User Notes](USER_NOTES.md) - 📝 Personal trading notes
|
||
- [Market Research Report](market_research_report.md) - 📊 AI-generated analysis
|
||
- [Upgrade Suggestions](upgrade_suggestions.md) - 💡 Improvement ideas
|
||
|
||
---
|
||
|
||
## 🔒 Security & Secrets
|
||
|
||
**Manage credentials and sensitive data:**
|
||
|
||
- [**Secrets Management**](Secrets_Management.md) - 🔐 API keys and credentials
|
||
- [**Cloudflare Guide**](CLOUDFLARE_GUIDE.md) - 🌐 Domain and DNS management
|
||
- [DNS Config Recommendation](DNS_CONFIG_RECOMMENDATION.md) - 📋 DNS best practices
|
||
|
||
---
|
||
|
||
## 📊 CI/CD & Workflows
|
||
|
||
**Continuous Integration and Deployment:**
|
||
|
||
- [**CD Workflow Guide**](CD_WORKFLOW_GUIDE.md) - 🔄 Comprehensive deployment automation
|
||
- [**CD Quick Reference**](CD_QUICK_REFERENCE.md) - 📝 Quick workflow reference
|
||
- [**GitHub CI/CD Setup**](GITHUB_CI_CD_SETUP.md) - ⚙️ GitHub Actions configuration
|
||
- [GitHub Actions Workflows](../.github/workflows/) - 📁 Workflow definitions
|
||
|
||
---
|
||
|
||
## 📊 Reports & Analysis
|
||
|
||
**Project health and quality reports:**
|
||
|
||
- [**Repository Quality Analysis**](Repository_Quality_Analysis.md) - 🔍 Code quality
|
||
- [**Performance Optimizations**](PERFORMANCE_OPTIMIZATIONS.md) - ⚡ Speed improvements
|
||
- [Working Tree Review Report](Working_Tree_Review_Report.md) - 🌳 Branch analysis
|
||
- [Pull Request Review Report](Pull_Request_Review_Report.md) - 🔀 PR analysis
|
||
|
||
**PR Consolidation Reports:**
|
||
- [Action Summary](PR_Action_Summary.md)
|
||
- [Consolidation Plan](PR_Consolidation_Plan.md)
|
||
- [Consolidation Results](PR_Consolidation_Results.md)
|
||
- [Final Summary](PR_Final_Summary.md)
|
||
- [Consolidation Complete](PR_Consolidation_Complete.md)
|
||
|
||
---
|
||
|
||
## 🌐 Web & UI
|
||
|
||
**Web dashboard and Progressive Web App:**
|
||
|
||
- [**PWA Guide**](PWA_GUIDE.md) - 📱 Progressive Web App implementation
|
||
- [**Service Worker Inspector**](SERVICE_WORKER_INSPECTOR.md) - 🔍 PWA debugging
|
||
- [Echo Hello Guide](Echo_Hello_Guide.md) - 👋 Demo scripts
|
||
|
||
---
|
||
|
||
## 📖 GitHub Features & Best Practices
|
||
|
||
**Improve your GitHub presence:**
|
||
|
||
- [**GitHub Profile README Guide**](GitHub_Profile_README_Guide.md) - ✨ Impressive profile page
|
||
- [**GitHub Gists Guide**](GitHub_Gists_Guide.md) - 📎 Share code snippets
|
||
|
||
---
|
||
|
||
## 🔍 Search Tips
|
||
|
||
- Use browser search (Ctrl+F / Cmd+F) to find specific topics
|
||
- Check the main [README](../README.md) for quick links
|
||
- See [REPOSITORY_LINKS](../REPOSITORY_LINKS.md) for external resources
|
||
- Explore the [scripts/](../scripts/) directory for automation tools
|
||
|
||
---
|
||
|
||
## 📞 Need Help?
|
||
|
||
- **GitHub Issues**: [Report bugs or request features](https://github.com/A6-9V/MQL5-Google-Onedrive/issues)
|
||
- **GitHub Discussions**: [Ask questions](https://github.com/A6-9V/MQL5-Google-Onedrive/discussions)
|
||
- **Contributing**: See [CONTRIBUTING.md](../CONTRIBUTING.md) for guidelines
|
||
- **WhatsApp**: [Join our community](https://chat.whatsapp.com/DYemXrBnMD63K55bjUMKYF)
|
||
|
||
---
|
||
|
||
**Last Updated**: 2026-02-14
|
||
**Maintainer**: A6-9V
|
||
**License**: See [LICENSE](../LICENSE)
|