# feat: implement clean documentation structure with automated sync workflow

[bitsalv]

🎯 Overview

This PR implements a clean documentation repository structure with automated sync workflow, addressing the issue edge-mining/edgemining.energy#2.

✨ Features Implemented

📝 Clean Documentation Structure

• Markdown-only: Repository contains only documentation content
• Editor-focused: Clear workflow for content contributors
• Organized structure: Logical organization of documentation files

🔄 Automated Sync Workflow

• GitHub Actions workflow to automatically sync changes to website repository
• Triggers on any documentation changes in docs/ directory
• Seamless integration with website deployment

📚 Initial Content Structure

• docs/intro.md: Basic project introduction (needs expansion)
• docs/about-us.md: Initial mission and values (placeholder content)
• docs/product/: Product documentation foundation (to be developed)
• docs/modelling/: Architecture documentation skeleton (needs content)
• docs/contribution.md: Basic contribution guidelines (requires refinement)
• docs/faq.md: Initial FAQ structure (needs more questions/answers)

🛠️ Workflow for Editors

1. Edit Documentation → docs/ directory
2. Test Locally → VuePress preview  
3. Create PR → This repository
4. Auto-Sync → edge-mining/edgemining.energy
5. Auto-Deploy → Live site (edgemining.energy)

📁 Repository Structure

docs/
├── intro.md              # Introduction
├── about-us.md           # About Edge Mining  
├── product/              # Product documentation
│   └── product-cycle.md
├── modelling/            # Architecture & DDD
│   ├── README.md
│   ├── domain-driven-architecture-overview.md
│   └── glossary.md
├── contribution.md       # How to contribute
└── faq.md               # Frequently asked questions

⚙️ Setup Required

1. GitHub Secret: Add EDGEMINING_ENERGY_TOKEN for sync workflow
2. Repository Permissions: Token needs write access to edge-mining/edgemining.energy

🔗 Related

• Addresses edge-mining/edgemining.energy#2. - Automating Documentation Publishing w/ GitHub Actions
• Companion PR: VuePress website implementation in edge-mining/edgemining.energy

✅ Benefits

• 📝 Editor-friendly: Contributors only work with Markdown files
• 🔄 Automated: No manual steps for publishing
• 🎯 Focused: Repository dedicated solely to documentation content
• 🚀 Fast: Immediate deployment of documentation changes

⚠️ Note

This PR provides the foundation structure for the workflow proposed in edge-mining/edgemining.energy#2. The documentation setup is functional but requires significant content development:

• Content Quality: Current documentation is basic and needs substantial expansion
• Technical Details: Architecture and product documentation need detailed development
• User Guides: Comprehensive user guides and tutorials need to be created
• Examples: Code examples and use cases need to be added
• Review: All content requires technical review and refinement

This foundation enables immediate automated publishing workflow while providing a clear structure for comprehensive documentation development.