# feat: implement clean documentation structure with automated sync workflow

.github/workflows/sync-docs.yml

@@ -0,0 +1,46 @@
+name: Sync Documentation Content
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+  workflow_dispatch: # Manual trigger
+
+jobs:
+  sync-docs-content:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout docs repository
+        uses: actions/checkout@v4
+        with:
+          path: docs-repo
+
+      - name: Checkout edgemining.energy repository
+        uses: actions/checkout@v4
+        with:
+          repository: edge-mining/edgemining.energy
+          token: ${{ secrets.EDGEMINING_ENERGY_TOKEN }}
+          path: edgemining-energy
+
+      - name: Sync docs content to edgemining.energy
+        run: |
+          # Remove existing docs directory
+          rm -rf edgemining-energy/docs
+
+          # Copy docs content
+          cp -r docs-repo/docs edgemining-energy/
+
+      - name: Commit and push to edgemining.energy
+        working-directory: edgemining-energy
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add docs/
+          git commit -m "Auto-sync: Update docs content from edge-mining/docs [skip ci]"
+          git push origin main

.gitignore

@@ -0,0 +1,29 @@
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Temporary files
+*.tmp
+*.temp
+
+# Backup files
+*.bak
+*.backup 

README.md

@@ -1,65 +1,116 @@
-⚠️ **Disclaimer**: *This project is in a preliminary state and under active development. Features and functionality may change significantly.*
+# Edge Mining Documentation Repository
 
-➡️ **Development Note**:
-- This is the **Docs repository**, specifically dedicated to documentation of the Edge Mining application.
-- The [Core repository](https://github.com/edge-mining/core) contains the main engine of the Edge Mining system.
-- The [Add-on repository](https://github.com/edge-mining/addon) provides the Home Assistant integration.
+This repository contains **only the documentation content** (Markdown files) for the Edge Mining website. The live site at [edgemining.energy](https://edgemining.energy) is automatically built and deployed from the [edge-mining/edgemining.energy](https://github.com/edge-mining/edgemining.energy) repository.
 
+## 🎯 For Documentation Editors
 
-# ⚡ Bitcoin Mining for Energy Efficiency
+This repository is specifically for **editing and maintaining the documentation content**. All documentation changes should be made here and will be automatically synced to the website repository.
 
-Bitcoin mining represents a unique opportunity to improve efficiency in both the production and use of energy, whether on an industrial scale or for smaller setups. This project aims to make mining accessible and easy to implement, providing tools to integrate mining into energy systems and maximize the use of the energy produced.
+> **📝 For Editors**: This repository is for **content editing** - writing, updating, and maintaining documentation. If you're a **developer** making technical changes to the website, use the [edge-mining/edgemining.energy](https://github.com/edge-mining/edgemining.energy) repository instead.
 
-## 🌞 The Challenge: Managing Excess Energy
+## 📁 Repository Structure
 
-In energy production plants, especially those relying on renewable sources like solar and wind, there's often a surplus of energy generated during peak hours (for example, when there is a lot of sun or wind) that doesn't align with peak demand times. Today, the main options for managing this excess energy include:
+```
+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
+```
 
-- **Selling the energy to the national grid**: This is possible only if the grid accepts the surplus, and often at unfavorable economic conditions.
-- **Purchasing additional storage systems**: Such as batteries, which can be expensive and not always scalable, limiting this option for many small producers.
-- **Using the energy for various purposes**: For instance, producing hydrogen through electrolysis, charging electric vehicles, or pumping water for hydroelectric storage. However, these solutions are often challenging and costly to implement, especially for small- and medium-sized plants.
-- **Using energy for marginal purposes**: Such as resistive heating, which generally doesn’t add significant economic value.
-- **Wasting the energy**: Which is a loss that reduces the overall efficiency of the plant.
+## 🔄 Workflow for Documentation Changes
 
-## 🔌 The Solution: Bitcoin Mining
+### **How to Contribute:**
 
-Bitcoin mining is a computational process that verifies and validates transactions on the Bitcoin network. This process ensures network security, using electrical energy to power specialized devices called miners. In return for this activity, miners receive a reward in Bitcoin, making mining not only useful for the network but also economically beneficial for participants.
+1. **Edit Documentation**: Modify Markdown files in the `docs/` directory
+2. **Test Locally**: Use the VuePress site to preview changes
+3. **Commit Changes**: Push to this repository
+4. **Automatic Sync**: Changes are automatically synced to [edge-mining/edgemining.energy](https://github.com/edge-mining/edgemining.energy)
+5. **Live Update**: Website is automatically updated at [edgemining.energy](https://edgemining.energy)
 
-This process has a unique feature that makes it particularly suitable for integration with renewable energy production plants: it is extremely flexible, able to be activated to consume energy during times of surplus and stopped immediately when energy is needed for other purposes.
+### **Repository Relationships:**
 
-Moreover, mining produces heat as a byproduct. 100% of the electrical energy used by a miner is converted into heat, making it similar to an electric heater that, in addition to providing warmth, also generates a constant economic reward.
+```
+Documentation Repository (edge-mining/docs) - FOR EDITORS
+    ↓ (Auto-sync)
+Website Repository (edge-mining/edgemining.energy) - FOR DEVELOPERS
+    ↓ (Auto-deploy)
+Live Site (edgemining.energy)
+```
 
-These characteristics make mining an ideal solution for managing excess energy, particularly in small- and medium-sized plants.
+## 🛠️ Local Development
 
-## 🏡 Edge Mining: A Practical Approach for Everyone
+### **For Documentation Editing:**
 
-Aside from electrical power, mining only requires a miner and a low-speed internet connection. It virtually needs nothing else, making it a very simple activity to implement anywhere.
+```bash
+# Clone this repository
+git clone https://github.com/edge-mining/docs.git
+cd docs
 
-You could say that the hardware implementation of a mining system is not particularly complex from a technical standpoint. In trying to implement it ourselves, we realized that the only missing element for a fully functional system was a management and automation solution for the mining process, specifically software that connects the energy production plant to the miners, regulating power on/off and energy consumption.
+# Edit Markdown files in docs/
+# Test with VuePress (see below)
+# Commit and push changes
+```
 
-Our project aims to develop a mining management system that:
+### **For Preview with VuePress:**
 
-- Connects the power generation plant with one or more ASIC devices for mining.
-- Allows users, even non-experts, to automate the mining process based on specific energy requirements.
-- Helps users manage and make the most of the heat generated by the ASICs for space heating, thereby maximizing the energy surplus of the plant.
+```bash
+# Navigate to the website repository
+cd ../edgemining.energy
 
-## 💾​ Development
+# Install dependencies
+npm install
 
-Following the general overview of the project, the following link provides a deeper technical insight into how the system is structured according to Domain-Driven Design (DDD) principles. It identifies the core domain of energy optimization, categorizes supporting and generic subdomains, defines the internal structure of each, and maps the interactions between them. This approach allows us to align the software architecture with real-world needs, ensuring clarity, modularity, and scalability. The document is continuously evolving and reflects an iterative design process—nothing is final, and all aspects are considered open to revision as the system and its understanding mature over time.
+# Start development server
+npm run docs:dev
 
-[👉Domain-Driven Architecture Overview](./modelling/domain-driven-architecture-overview.md)
+# View at http://localhost:8080
+```
 
-The following link provides access to a shared vocabulary used throughout the Edge Mining project, following the principles of Ubiquitous Language from Domain-Driven Design (DDD). It is organized by subdomain and offers simplified definitions based on domain expertise. The goal is to ensure consistent communication between developers, domain experts, and stakeholders, and to serve as a reference point during design and implementation.
+## 📝 Documentation Guidelines
 
-[👉Glossary](./modelling/glossary.md)
+### **File Organization:**
+- **`docs/intro.md`**: Project introduction and overview
+- **`docs/about-us.md`**: Mission, values, and team information
+- **`docs/product/`**: Product-specific documentation
+- **`docs/modelling/`**: Architecture and technical documentation
+- **`docs/contribution.md`**: How to contribute to the project
+- **`docs/faq.md`**: Frequently asked questions
 
----
+### **Markdown Standards:**
+- Use relative links: `./about-us.md` instead of `/docs/about-us.html`
+- Include proper frontmatter for VuePress
+- Follow consistent formatting and structure
+- Update table of contents when adding new pages
+
+## 🔗 Important Links
+
+- **Website Repository**: [edge-mining/edgemining.energy](https://github.com/edge-mining/edgemining.energy) (for developers)
+- **Live Website**: [edgemining.energy](https://edgemining.energy)
+- **Community**: [Discord](https://discord.com/invite/VQa9UY5SsS)
 
-## ✏️ Conclusion
+## ⚠️ Important Notes
 
-Edge Mining proposes an innovative solution to optimize the use of excess energy produced by small power plants, particularly renewable ones. Integrating Bitcoin mining is a flexible, economically advantageous, and easy-to-implement choice. With our mining management system, users can maximize the efficiency of their plant, utilize the heat produced, and contribute positively to the Bitcoin network. This approach turns a potential inefficiency into a concrete opportunity for profit and sustainable energy use.
+- **Auto-sync**: Changes here are automatically synced to the website repository
+- **No direct editing**: Don't edit the website repository directly for documentation changes
+- **Immediate deployment**: Changes appear on the live site after sync
+- **Editor-focused**: This repository is for content editors, not developers
 
-## 🤝 Contributions and Feedback
+## 🎯 Next Steps for Contributors
 
-We welcome contributions and feedback to make this project even better. Feel free to open issues or submit pull requests.
+1. **Fork this repository** (if you haven't already)
+2. **Make your changes** to the documentation
+3. **Test locally** using the VuePress development server
+4. **Create a Pull Request** to this repository
+5. **Wait for review and merge**
+6. **Changes will automatically appear** on the live site
+
+---
 
-Let’s mine smarter, together.
+**Note**: This repository is for documentation content only. The VuePress website and deployment infrastructure are in the [edge-mining/edgemining.energy](https://github.com/edge-mining/edgemining.energy) repository. 

docs/about-us.md

@@ -0,0 +1,74 @@
+# About Us
+
+## Our Story
+
+Edge Mining was born from a simple observation: energy often goes unused during low-demand periods. Instead of selling this energy cheaply, investing in costly storage solutions, or simply wasting it, we saw an opportunity to convert surplus energy directly into Bitcoin, creating sustainable and intelligent value.
+
+## Our Mission
+
+We believe that energy should never go to waste. Our mission is to unlock new economic possibilities from otherwise wasted resources by leveraging the power of Bitcoin mining to create value from surplus energy.
+
+## Why We Exist
+
+Energy often goes unused during low-demand periods. Instead of selling cheaply, investing in costly storage, or wasting this energy, Edge Mining converts it directly into Bitcoin, creating value sustainably and intelligently.
+
+## Our Approach
+
+### Research-Driven Development
+
+We take a research-driven approach to everything we do. Our team continuously explores new technologies, methodologies, and approaches to ensure that Edge Mining remains at the forefront of energy optimization.
+
+### Open Source Philosophy
+
+We believe in the power of open source. By making our code transparent and accessible, we enable collaboration, innovation, and community-driven development. There are no licensing fees - Edge Mining is 100% open source.
+
+### Community Focus
+
+Our community is at the heart of everything we do. We believe that the best solutions come from collaboration and shared knowledge. Whether you're a developer, energy enthusiast, or simply curious about the project, there's a place for you in our community.
+
+## We're in Alpha
+
+Edge Mining is currently in an early, alpha stage of development. Our research-driven approach is rapidly evolving, and features, performance, and reliability are continuously improving.
+
+### What This Means
+
+- **Active Development**: We're constantly working on new features and improvements
+- **Research Phase**: We're exploring different approaches and technologies
+- **Community Input**: Your feedback and contributions are invaluable
+- **Rapid Evolution**: The project is changing and improving quickly
+
+## Key Features
+
+### Smart Automation
+
+Intelligent automation based on energy availability to maximize efficiency. Our systems automatically adjust to energy availability, ensuring optimal performance.
+
+### Heat Recovery
+
+Advanced heat recovery systems for practical applications. We don't just mine Bitcoin - we also recover and utilize the heat generated during the mining process.
+
+### Versatile Sizing
+
+Designed for small to medium energy installations. Whether you have a small solar setup or a medium-sized wind farm, Edge Mining can work for you.
+
+### 100% Open Source
+
+Fully open-source with no licensing fees. You can inspect, modify, and contribute to the codebase.
+
+## Get Involved
+
+Join our growing community of developers and energy enthusiasts. Together, we're building the future of energy optimization.
+
+### Discord
+
+Connect with our community to discuss ideas, ask questions, and collaborate on new features.
+
+### GitHub
+
+Explore our codebase, contribute to development, or fork the project to create your own solution.
+
+## Contact
+
+- **GitHub**: [edge-mining](https://github.com/edge-mining)
+- **Discord**: [Join our community](https://discord.com/invite/VQa9UY5SsS)
+- **Website**: [edgemining.energy](https://edgemining.energy)