Skip to content

Commit 2aa6046

Browse files
committed
fix: correct broken links and update repository structure
- Fix broken .html links to .md format - Update repository references from edge-mining to bitsalv - Correct Discord invite link - Update README to reflect actual repository structure - Synchronize documentation between repositories
1 parent 204dc62 commit 2aa6046

3 files changed

Lines changed: 52 additions & 44 deletions

File tree

README.md

Lines changed: 43 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,28 @@ This repository contains **only the documentation content** (Markdown files) for
44

55
## 🏗️ Repository Structure
66

7-
### **This Repository (`edge-mining/docs`):**
7+
### **This Repository (`bitsalv/edgemining-docs`):**
88
```
9-
edge-mining/docs/
10-
└── docs/ # Documentation content ONLY
11-
├── intro.md # Introduction
12-
├── about-us.md # About Edge Mining
13-
├── product/ # Product documentation
14-
│ └── product-cycle.md
15-
├── modelling/ # Architecture & DDD
16-
│ ├── domain-driven-architecture-overview.md
17-
│ └── glossary.md
18-
├── contribution.md # How to contribute
19-
└── faq.md # Frequently asked questions
9+
edgemining-docs/
10+
├── docs/ # Documentation content ONLY
11+
│ ├── intro.md # Introduction
12+
│ ├── about-us.md # About Edge Mining
13+
│ ├── product/ # Product documentation
14+
│ │ └── product-cycle.md
15+
│ ├── modelling/ # Architecture & DDD
16+
│ │ ├── README.md
17+
│ │ ├── domain-driven-architecture-overview.md
18+
│ │ └── glossary.md
19+
│ ├── contribution.md # How to contribute
20+
│ └── faq.md # Frequently asked questions
21+
├── images/ # Documentation images
22+
└── .github/workflows/ # Sync workflow
2023
```
2124

22-
### **Site Repository (`edge-mining/edgemining.energy`):**
25+
### **Site Repository (`bitsalv/edgemining.energy`):**
2326
```
24-
edge-mining/edgemining.energy/
25-
├── docs/ # VuePress site (copied from this repo)
27+
edgemining.energy/
28+
├── docs/ # VuePress site (synced from this repo)
2629
│ ├── .vuepress/ # VuePress configuration
2730
│ │ ├── config.js # Site configuration
2831
│ │ ├── styles/ # Custom CSS styles
@@ -38,26 +41,26 @@ edge-mining/edgemining.energy/
3841
### **Two-Way Sync Process:**
3942

4043
#### **1. Content Changes (this repo):**
41-
- **Push to `edge-mining/docs`** → Triggers sync workflow
42-
- **Copies `docs/`**`edge-mining/edgemining.energy/docs/`
44+
- **Push to `bitsalv/edgemining-docs`** → Triggers sync workflow
45+
- **Copies `docs/`**`bitsalv/edgemining.energy/docs/`
4346
- **Triggers build** → Deploys to `edgemining.energy`
4447

4548
#### **2. Site Changes (edgemining.energy repo):**
46-
- **Push to `edge-mining/edgemining.energy`** → Triggers build workflow
49+
- **Push to `bitsalv/edgemining.energy`** → Triggers build workflow
4750
- **Builds VuePress** → Deploys to `edgemining.energy`
4851

4952
## 🛠️ Setup Required
5053

5154
### **1. Repository Token**
52-
In the `edge-mining/docs` repository, add this secret:
55+
In the `bitsalv/edgemining-docs` repository, add this secret:
5356
```
5457
EDGEMINING_ENERGY_TOKEN = Personal Access Token with permissions on edgemining.energy
5558
```
5659

5760
### **2. Repository Permissions**
5861
The token must have access to:
59-
- `edge-mining/docs` (read)
60-
- `edge-mining/edgemining.energy` (read/write)
62+
- `bitsalv/edgemining-docs` (read)
63+
- `bitsalv/edgemining.energy` (read/write)
6164

6265
## 📝 Current Status
6366

@@ -68,22 +71,25 @@ The token must have access to:
6871
- [x] Custom CSS styling with Edge Mining brand colors
6972
- [x] Logo and favicon from Edge Mining organization
7073
- [x] Navigation structure (Home, Docs, Discord, GitHub)
74+
- [x] Fixed broken links in documentation
75+
- [x] Synchronized content between repositories
7176

7277
### **⚠️ Pending:**
78+
- [ ] Configure `EDGEMINING_ENERGY_TOKEN` secret for automatic sync
79+
- [ ] Test deployment workflow
7380
- [ ] Content review and finalization
74-
- [ ] Visual design improvements
75-
- [ ] Testing of deployment workflow
7681

7782
## 🔧 Local Development
7883

7984
### **For Content Development (this repo):**
8085
```bash
8186
# Edit Markdown files in docs/
82-
# Push to trigger automatic sync
87+
# Push to trigger automatic sync (when token is configured)
8388
```
8489

8590
### **For Site Development (edgemining.energy repo):**
8691
```bash
92+
cd edgemining.energy
8793
npm run docs:dev # Development server
8894
npm run docs:build # Production build
8995
npm run docs:clean # Clean build
@@ -93,33 +99,35 @@ npm run docs:clean # Clean build
9399
- **Development**: `http://localhost:8080/` (from edgemining.energy repo)
94100
- **Production**: `https://edgemining.energy`
95101

96-
## 📋 Pull Request Checklist
102+
## 📋 Setup Checklist
97103

98-
### **For `edge-mining/docs`:**
104+
### **For `bitsalv/edgemining-docs`:**
105+
- [x] Repository structure corrected
106+
- [x] Documentation links fixed
99107
- [ ] Add `EDGEMINING_ENERGY_TOKEN` secret
100108
- [ ] Configure repository permissions
101109
- [ ] Test content sync workflow
102110

103-
### **For `edge-mining/edgemining.energy`:**
111+
### **For `bitsalv/edgemining.energy`:**
112+
- [x] VuePress configuration complete
113+
- [x] Build workflow functional
104114
- [ ] Enable GitHub Pages
105115
- [ ] Configure custom domain `edgemining.energy`
106116
- [ ] Set up CNAME file
107-
- [ ] Configure repository permissions
108117

109118
## 🎯 Next Steps
110119

111-
1. **Create Pull Request** for `edge-mining/docs` (content only)
112-
2. **Create Pull Request** for `edge-mining/edgemining.energy` (VuePress site)
113-
3. **Configure secrets** and permissions
114-
4. **Test deployment workflow**
115-
5. **Review and finalize content**
120+
1. **Configure GitHub Secrets** for automatic sync
121+
2. **Test deployment workflow**
122+
3. **Review and finalize content**
123+
4. **Enable GitHub Pages** with custom domain
116124

117125
## 📚 Documentation Files
118126

119-
- **`docs/docs/`** → All documentation content (this repo)
127+
- **`docs/`** → All documentation content (this repo)
120128
- **VuePress configuration** → In edgemining.energy repo
121129
- **Deployment workflows** → In both repositories
122130

123131
---
124132

125-
**Note**: This repository contains ONLY the documentation content. The VuePress site and deployment infrastructure are in the `edge-mining/edgemining.energy` repository.
133+
**Note**: This repository contains ONLY the documentation content. The VuePress site and deployment infrastructure are in the `bitsalv/edgemining.energy` repository.

docs/intro.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ Edge Mining is currently in an **alpha stage** of development. Our research-driv
2626

2727
To get involved with Edge Mining:
2828

29-
1. **Explore the Documentation**: Start with our [About Us](/docs/about-us.html) page
30-
2. **Understand the Product**: Learn about our [Product Cycle](/docs/product/product-cycle.html)
31-
3. **Study the Architecture**: Dive into our [Domain-Driven Architecture](/docs/modelling/domain-driven-architecture-overview.html)
32-
4. **Join the Community**: Connect with us on [Discord](https://discord.gg/edgemining) and [GitHub](https://github.com/edge-mining/docs)
29+
1. **Explore the Documentation**: Start with our [About Us](./about-us.md) page
30+
2. **Understand the Product**: Learn about our [Product Cycle](./product/product-cycle.md)
31+
3. **Study the Architecture**: Dive into our [Domain-Driven Architecture](./modelling/domain-driven-architecture-overview.md)
32+
4. **Join the Community**: Connect with us on [Discord](https://discord.com/invite/VQa9UY5SsS) and [GitHub](https://github.com/bitsalv/edgemining.energy)
3333

3434
## Next Steps
3535

36-
- [About Us](/docs/about-us.html) - Learn more about our mission and values
37-
- [Product Cycle](/docs/product/product-cycle.html) - Understand our development process
38-
- [Contribution](/docs/contribution.html) - Find out how to contribute
39-
- [FAQ](/docs/faq.html) - Get answers to common questions
36+
- [About Us](./about-us.md) - Learn more about our mission and values
37+
- [Product Cycle](./product/product-cycle.md) - Understand our development process
38+
- [Contribution](./contribution.md) - Find out how to contribute
39+
- [FAQ](./faq.md) - Get answers to common questions

docs/modelling/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ When contributing to the architecture:
5353

5454
## Related Resources
5555

56-
- [Main Project Repository](https://github.com/edge-mining/docs)
56+
- [Main Project Repository](https://github.com/bitsalv/edgemining.energy)
5757
- [Domain-Driven Design Resources](https://martinfowler.com/bliki/DomainDrivenDesign.html)
5858
- [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
5959
- [Event Sourcing](https://martinfowler.com/eaaDev/EventSourcing.html)

0 commit comments

Comments
 (0)