You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: update README for developers and sync documentation
- Update README to be developer-focused with clear workflow
- Add specific guidance for developers vs editors
- Clarify repository relationships and contribution workflow
- Fix repository references to original edge-mining repositories
- Sync updated documentation from edgemining-docs
- Remove duplicate modelling files and clean structure
@@ -47,17 +47,60 @@ Connect with our community to discuss ideas, ask questions, and collaborate on n
47
47
48
48
Explore our codebase, contribute to development, or fork the project to create your own solution.
49
49
50
-
<ahref="https://github.com/bitsalv/edgemining.energy"target="_blank"class="action-button">View on GitHub</a>
50
+
<ahref="https://github.com/edge-mining/edgemining.energy"target="_blank"class="action-button">View on GitHub</a>
51
51
52
52
---
53
53
54
54
## Repository Information
55
55
56
-
This repository contains the **VuePress website** for Edge Mining. The documentation content is automatically synced from the [edgemining-docs](https://github.com/bitsalv/edgemining-docs) repository.
56
+
This repository contains the **VuePress website** for Edge Mining. The documentation content is automatically synced from the [edge-mining/docs](https://github.com/edge-mining/docs) repository.
57
57
58
-
### Local Development
58
+
### 🎯 For Website Developers
59
+
60
+
This repository is for **website development and deployment**. The documentation content is automatically synced from the [edge-mining/docs](https://github.com/edge-mining/docs) repository.
61
+
62
+
> **🛠️ For Developers**: This repository is for **technical development** - VuePress configuration, styling, build processes, and deployment. If you're an **editor** making content changes, use the [edge-mining/docs](https://github.com/edge-mining/docs) repository instead.
63
+
64
+
### 🔄 Repository Workflow
65
+
66
+
```
67
+
Documentation Changes:
68
+
edge-mining/docs (FOR EDITORS)
69
+
↓ (Auto-sync)
70
+
edge-mining/edgemining.energy (FOR DEVELOPERS)
71
+
↓ (Auto-deploy)
72
+
Live Site (edgemining.energy)
73
+
74
+
Website Changes:
75
+
edge-mining/edgemining.energy (FOR DEVELOPERS)
76
+
↓ (Auto-deploy)
77
+
Live Site (edgemining.energy)
78
+
```
79
+
80
+
### 📁 Repository Structure
81
+
82
+
```
83
+
edgemining.energy/
84
+
├── docs/ # VuePress site (auto-synced from edge-mining/docs)
85
+
│ ├── .vuepress/ # VuePress configuration
86
+
│ │ ├── config.js # Site configuration
87
+
│ │ ├── styles/ # Custom CSS styles
88
+
│ │ └── public/ # Static assets (logo, favicon)
89
+
│ ├── docs/ # Documentation content (auto-synced)
90
+
│ └── README.md # Homepage content
91
+
├── package.json # Dependencies and scripts
92
+
└── .github/workflows/ # Build and deploy workflows
-**Auto-deploy**: Changes here automatically deploy to the live site
143
+
-**Documentation sync**: Documentation is automatically synced from edge-mining/docs
144
+
-**No direct editing**: Don't edit documentation content here
145
+
-**Developer-focused**: This repository is for technical development, not content editing
146
+
147
+
## 🎯 Next Steps for Contributors
148
+
149
+
1.**Fork this repository** (if you haven't already)
150
+
2.**Make your changes** to the website/VuePress configuration
151
+
3.**Test locally** using the development server
152
+
4.**Create a Pull Request** to this repository
153
+
5.**Wait for review and merge**
154
+
6.**Changes will automatically deploy** to the live site
155
+
156
+
---
75
157
76
-
This site is automatically built and deployed to GitHub Pages when changes are pushed to the `main` branch. The live site is available at [edgemining.energy](https://edgemining.energy).
158
+
**Note**: This repository is for the VuePress website only. Documentation content should be edited in the [edge-mining/docs](https://github.com/edge-mining/docs) repository.
0 commit comments