Skip to content

Commit 6fa18a7

Browse files
authored
Merge branch 'develop' into blcu-improvements
2 parents 8cad2d9 + 7cf9d03 commit 6fa18a7

20 files changed

Lines changed: 2086 additions & 66 deletions

File tree

.github/workflows/release.yaml

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -393,9 +393,12 @@ jobs:
393393
# Copy common files
394394
cp -r artifacts/common-files/* release-linux/
395395
396+
# Set executable permissions
397+
chmod +x release-linux/backend release-linux/updater release-linux/testadj
398+
396399
# Create Linux release archive
397400
cd release-linux
398-
zip -r ../linux-$VERSION.zip .
401+
tar -czf ../linux-$VERSION.tar.gz .
399402
400403
- name: Organize Windows release files
401404
run: |
@@ -445,9 +448,12 @@ jobs:
445448
# Copy common files
446449
cp -r artifacts/common-files/* release-macos/
447450
451+
# Set executable permissions
452+
chmod +x release-macos/backend release-macos/updater release-macos/testadj
453+
448454
# Create macOS Intel release archive
449455
cd release-macos
450-
zip -r ../macos-intel-$VERSION.zip .
456+
tar -czf ../macos-intel-$VERSION.tar.gz .
451457
452458
- name: Organize macOS ARM64 release files
453459
run: |
@@ -471,15 +477,20 @@ jobs:
471477
# Copy common files
472478
cp -r artifacts/common-files/* release-macos-arm64/
473479
480+
# Set executable permissions
481+
chmod +x release-macos-arm64/backend release-macos-arm64/updater release-macos-arm64/testadj
482+
474483
# Create macOS ARM64 release archive
475484
cd release-macos-arm64
476-
zip -r ../macos-arm64-$VERSION.zip .
485+
tar -czf ../macos-arm64-$VERSION.tar.gz .
477486
478487
- name: Upload release packages
479488
uses: actions/upload-artifact@v4
480489
with:
481490
name: releases
482-
path: "*.zip"
491+
path: |
492+
*.tar.gz
493+
*.zip
483494
retention-days: 7
484495
compression-level: 9
485496

@@ -502,9 +513,9 @@ jobs:
502513
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
503514
with:
504515
upload_url: ${{ steps.create_release.outputs.upload_url }}
505-
asset_path: ./linux-${{ github.event.inputs.version }}.zip
506-
asset_name: linux-${{ github.event.inputs.version }}.zip
507-
asset_content_type: application/zip
516+
asset_path: ./linux-${{ github.event.inputs.version }}.tar.gz
517+
asset_name: linux-${{ github.event.inputs.version }}.tar.gz
518+
asset_content_type: application/gzip
508519

509520
- name: Upload Windows package to release
510521
if: github.event_name == 'workflow_dispatch'
@@ -524,9 +535,9 @@ jobs:
524535
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
525536
with:
526537
upload_url: ${{ steps.create_release.outputs.upload_url }}
527-
asset_path: ./macos-intel-${{ github.event.inputs.version }}.zip
528-
asset_name: macos-intel-${{ github.event.inputs.version }}.zip
529-
asset_content_type: application/zip
538+
asset_path: ./macos-intel-${{ github.event.inputs.version }}.tar.gz
539+
asset_name: macos-intel-${{ github.event.inputs.version }}.tar.gz
540+
asset_content_type: application/gzip
530541

531542
- name: Upload macOS ARM64 package to release
532543
if: github.event_name == 'workflow_dispatch'
@@ -535,9 +546,9 @@ jobs:
535546
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
536547
with:
537548
upload_url: ${{ steps.create_release.outputs.upload_url }}
538-
asset_path: ./macos-arm64-${{ github.event.inputs.version }}.zip
539-
asset_name: macos-arm64-${{ github.event.inputs.version }}.zip
540-
asset_content_type: application/zip
549+
asset_path: ./macos-arm64-${{ github.event.inputs.version }}.tar.gz
550+
asset_name: macos-arm64-${{ github.event.inputs.version }}.tar.gz
551+
asset_content_type: application/gzip
541552

542553
- name: Upload Linux package to existing release
543554
if: github.event_name == 'release'
@@ -546,9 +557,9 @@ jobs:
546557
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
547558
with:
548559
upload_url: ${{ github.event.release.upload_url }}
549-
asset_path: ./linux-${{ github.event.release.tag_name }}.zip
550-
asset_name: linux-${{ github.event.release.tag_name }}.zip
551-
asset_content_type: application/zip
560+
asset_path: ./linux-${{ github.event.release.tag_name }}.tar.gz
561+
asset_name: linux-${{ github.event.release.tag_name }}.tar.gz
562+
asset_content_type: application/gzip
552563

553564
- name: Upload Windows package to existing release
554565
if: github.event_name == 'release'
@@ -568,9 +579,9 @@ jobs:
568579
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
569580
with:
570581
upload_url: ${{ github.event.release.upload_url }}
571-
asset_path: ./macos-intel-${{ github.event.release.tag_name }}.zip
572-
asset_name: macos-intel-${{ github.event.release.tag_name }}.zip
573-
asset_content_type: application/zip
582+
asset_path: ./macos-intel-${{ github.event.release.tag_name }}.tar.gz
583+
asset_name: macos-intel-${{ github.event.release.tag_name }}.tar.gz
584+
asset_content_type: application/gzip
574585

575586
- name: Upload macOS ARM64 package to existing release
576587
if: github.event_name == 'release'
@@ -579,6 +590,6 @@ jobs:
579590
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
580591
with:
581592
upload_url: ${{ github.event.release.upload_url }}
582-
asset_path: ./macos-arm64-${{ github.event.release.tag_name }}.zip
583-
asset_name: macos-arm64-${{ github.event.release.tag_name }}.zip
584-
asset_content_type: application/zip
593+
asset_path: ./macos-arm64-${{ github.event.release.tag_name }}.tar.gz
594+
asset_name: macos-arm64-${{ github.event.release.tag_name }}.tar.gz
595+
asset_content_type: application/gzip
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Test Development Scripts
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- scripts/**
7+
workflow_dispatch:
8+
9+
jobs:
10+
test-dev-scripts:
11+
name: Test Development Scripts
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
matrix:
15+
include:
16+
- os: ubuntu-latest
17+
name: linux
18+
shell: bash
19+
script: ./scripts/dev.sh
20+
21+
- os: windows-latest
22+
name: windows-powershell
23+
shell: pwsh
24+
script: .\scripts\dev.ps1
25+
26+
- os: windows-latest
27+
name: windows-cmd
28+
shell: cmd
29+
script: scripts\dev.cmd
30+
31+
- os: macos-latest
32+
name: macos
33+
shell: bash
34+
script: ./scripts/dev.sh
35+
36+
steps:
37+
- uses: actions/checkout@v4
38+
39+
- name: Setup Go
40+
uses: actions/setup-go@v4
41+
with:
42+
go-version: "1.21.3"
43+
44+
- name: Setup Node.js
45+
uses: actions/setup-node@v4
46+
with:
47+
node-version: '18'
48+
cache: 'npm'
49+
50+
- name: Install tmux (Linux/macOS)
51+
if: matrix.os != 'windows-latest'
52+
run: |
53+
if [ "${{ matrix.os }}" = "ubuntu-latest" ]; then
54+
sudo apt-get update && sudo apt-get install -y tmux
55+
elif [ "${{ matrix.os }}" = "macos-latest" ]; then
56+
brew install tmux
57+
fi
58+
shell: bash
59+
60+
- name: Make script executable (Unix)
61+
if: matrix.os != 'windows-latest'
62+
run: chmod +x scripts/dev.sh
63+
shell: bash
64+
65+
- name: Test script help/usage
66+
run: ${{ matrix.script }}
67+
shell: ${{ matrix.shell }}
68+
continue-on-error: true
69+
70+
- name: Test dependency check
71+
run: ${{ matrix.script }} setup
72+
shell: ${{ matrix.shell }}
73+
74+
- name: Test build command
75+
run: ${{ matrix.script }} build
76+
shell: ${{ matrix.shell }}
77+
continue-on-error: true
78+
79+
- name: Test backend build (quick test)
80+
run: ${{ matrix.script }} test
81+
shell: ${{ matrix.shell }}
82+
continue-on-error: true

DOCUMENTATION_REORGANIZATION.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Documentation Reorganization Summary
2+
3+
This document outlines the reorganization of project documentation from scattered files to a centralized `docs/` folder structure.
4+
5+
## 📁 New Documentation Structure
6+
7+
```
8+
docs/
9+
├── README.md # Main documentation index
10+
├── architecture/
11+
│ └── README.md # System architecture overview
12+
├── development/
13+
│ ├── DEVELOPMENT.md # Development setup guide
14+
│ ├── CROSS_PLATFORM_DEV_SUMMARY.md # Cross-platform scripts documentation
15+
│ └── scripts.md # Scripts reference guide
16+
├── guides/
17+
│ └── getting-started.md # New user getting started guide
18+
└── troubleshooting/
19+
└── BLCU_FIX_SUMMARY.md # BLCU repair documentation
20+
```
21+
22+
## 📋 File Migrations
23+
24+
### Moved Files
25+
| Original Location | New Location | Status |
26+
|-------------------|--------------|--------|
27+
| `DEVELOPMENT.md` | `docs/development/DEVELOPMENT.md` | ✅ Moved |
28+
| `CROSS_PLATFORM_DEV_SUMMARY.md` | `docs/development/CROSS_PLATFORM_DEV_SUMMARY.md` | ✅ Moved |
29+
| `scripts/README.md` | `docs/development/scripts.md` | ✅ Moved |
30+
| `backend/BLCU_FIX_SUMMARY.md` | `docs/troubleshooting/BLCU_FIX_SUMMARY.md` | ✅ Moved |
31+
32+
### New Files Created
33+
| File | Purpose |
34+
|------|---------|
35+
| `docs/README.md` | Main documentation index with navigation |
36+
| `docs/architecture/README.md` | System architecture overview |
37+
| `docs/guides/getting-started.md` | Comprehensive new user guide |
38+
| `scripts/README.md` | Quick reference pointing to full docs |
39+
40+
### Updated Files
41+
| File | Changes |
42+
|------|---------|
43+
| `README.md` | Added documentation section with quick links |
44+
| `docs/development/scripts.md` | Updated paths for new location |
45+
46+
## 🎯 Benefits of New Structure
47+
48+
### 1. **Improved Organization**
49+
- Clear categorization by purpose (development, architecture, guides, troubleshooting)
50+
- Logical hierarchy that scales as documentation grows
51+
- Centralized location for all project documentation
52+
53+
### 2. **Better Discoverability**
54+
- Single entry point through `docs/README.md`
55+
- Clear navigation between related documents
56+
- Quick links in main README for common tasks
57+
58+
### 3. **Enhanced User Experience**
59+
- Dedicated getting started guide for new users
60+
- Platform-specific guidance clearly organized
61+
- Troubleshooting docs easily accessible
62+
63+
### 4. **Maintainability**
64+
- Related documentation grouped together
65+
- Easier to update and maintain consistency
66+
- Clear ownership and responsibility areas
67+
68+
## 🚀 How to Use the New Structure
69+
70+
### For New Users
71+
1. Start with [`docs/guides/getting-started.md`](docs/guides/getting-started.md)
72+
2. Follow platform-specific setup in [`docs/development/DEVELOPMENT.md`](docs/development/DEVELOPMENT.md)
73+
3. Refer to troubleshooting docs if needed
74+
75+
### For Developers
76+
1. Check [`docs/development/`](docs/development/) for all development-related docs
77+
2. Use [`docs/architecture/`](docs/architecture/) to understand system design
78+
3. Reference [`docs/development/scripts.md`](docs/development/scripts.md) for tooling
79+
80+
### For Contributors
81+
1. Review existing documentation structure before adding new docs
82+
2. Place new documentation in appropriate category folders
83+
3. Update main index (`docs/README.md`) when adding major new sections
84+
85+
## 📝 Documentation Guidelines
86+
87+
### Placement Rules
88+
- **Development docs**`docs/development/`
89+
- **Architecture docs**`docs/architecture/`
90+
- **User guides**`docs/guides/`
91+
- **Troubleshooting**`docs/troubleshooting/`
92+
- **Component-specific** → Keep in respective component directories
93+
94+
### Linking Guidelines
95+
- Use relative paths for internal documentation links
96+
- Update `docs/README.md` index when adding major new documents
97+
- Cross-reference related documentation where helpful
98+
99+
### File Naming
100+
- Use lowercase with hyphens: `getting-started.md`
101+
- Use descriptive names that indicate content purpose
102+
- Keep README.md files for directory overviews
103+
104+
## 🔗 Key Entry Points
105+
106+
### Primary Documentation
107+
- **[docs/README.md](docs/README.md)** - Main documentation hub
108+
- **[README.md](README.md)** - Project overview with quick start
109+
110+
### Quick Access
111+
- **New Users**: [Getting Started Guide](docs/guides/getting-started.md)
112+
- **Developers**: [Development Setup](docs/development/DEVELOPMENT.md)
113+
- **Troubleshooting**: [Common Issues](docs/troubleshooting/BLCU_FIX_SUMMARY.md)
114+
115+
## 🎉 Migration Complete
116+
117+
The documentation reorganization provides:
118+
- ✅ Better organization and navigation
119+
- ✅ Improved new user experience
120+
- ✅ Clearer separation of concerns
121+
- ✅ Scalable structure for future growth
122+
- ✅ Maintained backward compatibility through redirect notes
123+
124+
All existing functionality remains accessible while providing a much better documentation experience for users, developers, and contributors.

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Download the latest release, unzip it and run the executable compatible with you
1414

1515
### For Developers
1616

17-
See [DEVELOPMENT.md](./DEVELOPMENT.md) for detailed setup instructions. Quick start:
17+
See our comprehensive [Documentation](./docs/README.md) or jump to [Getting Started](./docs/guides/getting-started.md). Quick start:
1818

1919
```bash
2020
# Clone and setup
@@ -34,7 +34,17 @@ When using the Control Station make sure that you have configured your IP as the
3434

3535
To change the ADJ branch from `main`, change the option `adj/branch` at the end of the `config.toml` with the name of the branch you want to use or leave it blank if you'll be making use of a custom ADJ.
3636

37-
### Contributing
37+
## Documentation
38+
39+
📚 **[Complete Documentation](./docs/README.md)** - All guides and references
40+
41+
### Quick Links
42+
- 🚀 **[Getting Started](./docs/guides/getting-started.md)** - New user guide
43+
- 🛠️ **[Development Setup](./docs/development/DEVELOPMENT.md)** - Developer environment setup
44+
- 🏗️ **[Architecture](./docs/architecture/README.md)** - System design overview
45+
- 🔧 **[Troubleshooting](./docs/troubleshooting/BLCU_FIX_SUMMARY.md)** - Common issues and fixes
46+
47+
## Contributing
3848

3949
See [CONTRIBUTING.md](./CONTRIBUTING.md) for ways to contribute to the Control Station.
4050

0 commit comments

Comments
 (0)