Skip to content

Commit 8ded866

Browse files
committed
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
1 parent 0bb2fe7 commit 8ded866

File tree

3 files changed

+452
-162
lines changed

3 files changed

+452
-162
lines changed

README.md

Lines changed: 88 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ actions:
77
link: /docs/intro.html
88
type: primary
99
- text: GitHub
10-
link: https://github.com/bitsalv/edgemining.energy
10+
link: https://github.com/edge-mining/edgemining.energy
1111
type: secondary
1212
features:
1313
- title: Smart automation
@@ -47,17 +47,60 @@ Connect with our community to discuss ideas, ask questions, and collaborate on n
4747

4848
Explore our codebase, contribute to development, or fork the project to create your own solution.
4949

50-
<a href="https://github.com/bitsalv/edgemining.energy" target="_blank" class="action-button">View on GitHub</a>
50+
<a href="https://github.com/edge-mining/edgemining.energy" target="_blank" class="action-button">View on GitHub</a>
5151

5252
---
5353

5454
## Repository Information
5555

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.
5757

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
93+
```
94+
95+
## 🛠️ Development
96+
97+
### **For Website Development:**
5998

6099
```bash
100+
# Clone this repository
101+
git clone https://github.com/edge-mining/edgemining.energy.git
102+
cd edgemining.energy
103+
61104
# Install dependencies
62105
npm install
63106

@@ -71,6 +114,45 @@ npm run docs:build
71114
npm run docs:clean
72115
```
73116

74-
### Automatic Deployment
117+
### **Access:**
118+
- **Development**: `http://localhost:8080/`
119+
- **Production**: [edgemining.energy](https://edgemining.energy)
120+
121+
## 📝 Contribution Workflow
122+
123+
### **For Documentation Changes:**
124+
1. **Don't edit docs here** - Edit in [edge-mining/docs](https://github.com/edge-mining/docs) instead
125+
2. **Documentation is auto-synced** from the documentation repository
126+
3. **Create PR to edge-mining/docs** for documentation changes
127+
128+
### **For Website Changes:**
129+
1. **Edit VuePress configuration** in this repository
130+
2. **Test locally** with `npm run docs:dev`
131+
3. **Create PR to this repository** for website changes
132+
4. **Changes auto-deploy** to the live site
133+
134+
## 🔗 Important Links
135+
136+
- **Documentation Repository**: [edge-mining/docs](https://github.com/edge-mining/docs) (for editors)
137+
- **Live Website**: [edgemining.energy](https://edgemining.energy)
138+
- **Community**: [Discord](https://discord.com/invite/VQa9UY5SsS)
139+
140+
## ⚠️ Important Notes
141+
142+
- **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+
---
75157

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

Comments
 (0)