ERPNext Database Documentation Platform

Comprehensive documentation platform for ERPNext database structure, customizations, and maintenance procedures.

🌟 Features

• Multi-Platform Documentation: GitBook for users, MkDocs for developers, Jupyter for interactive analysis
• Automated Maintenance: Python scripts for backup, monitoring, and health checks
• Version Control: Full Git integration with automated deployments
• Interactive Analysis: Jupyter notebooks for database exploration and monitoring

📚 Documentation Platforms

🎯 For Business Users - GitBook

URL: [Your GitBook URL]

• User-friendly interface
• Business impact analysis
• Executive summaries
• Contact information

🔧 For Developers - GitHub Pages (MkDocs)

URL: [Your GitHub Pages URL]

• Technical API reference
• Complete SQL schemas
• Code examples
• Troubleshooting guides

📊 For Database Administrators - Jupyter Notebooks

URL: [Your Jupyter Hub URL]

• Interactive monitoring dashboards
• Automated maintenance scripts
• Performance analysis tools
• Health check utilities

🚀 Quick Start

1. Clone Repository

git clone https://github.com/your-org/erpnext-database-docs.git
cd erpnext-database-docs

2. Setup Local Development

# Install MkDocs dependencies
pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-mermaid2-plugin

# Install Jupyter dependencies
pip install -r notebooks/requirements.txt

# Install maintenance script dependencies
pip install -r scripts/requirements.txt

3. Run Local Documentation

# Serve MkDocs locally
cd docs/mkdocs
mkdocs serve

# Run Jupyter notebooks
cd notebooks
jupyter notebook

📊 Database Overview

• Total Tables: 879 analyzed and categorized
• Custom Tables: 34 (ZRA Integration + WCFCB + Test)
• Standard Modules: 24 functional areas
• Critical Systems: ZRA tax compliance integration

🛠️ Maintenance Tools

Backup Custom Tables

python scripts/maintenance_scripts.py backup

Monitor ZRA Integration

python scripts/maintenance_scripts.py monitor-zra

Generate Health Report

python scripts/maintenance_scripts.py full-report

📁 Repository Structure

erpnext-database-docs/
├── docs/
│   ├── gitbook/          # GitBook source files
│   ├── mkdocs/           # MkDocs technical documentation
│   └── shared/           # Shared assets
├── database/             # SQL breakdown and schemas
├── scripts/              # Python maintenance tools
├── notebooks/            # Jupyter interactive analysis
├── .github/              # GitHub Actions workflows
└── assets/               # Images and diagrams

🔄 Automated Workflows

• Documentation Deployment: Auto-deploy to GitHub Pages and sync with GitBook
• Link Validation: Check for broken links in documentation
• Content Freshness: Monitor for outdated content
• Health Checks: Automated database health monitoring

📞 Support

• Documentation Issues: Create GitHub issue
• Database Questions: See support contacts
• Emergency Procedures: Follow emergency guide

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test documentation builds locally
5. Submit a pull request

📄 License

This documentation is proprietary to your organization. See LICENSE file for details.

---

This documentation platform is automatically maintained and synchronized across all platforms.