DAW/furt

Fork 0

Repository Redesign: Clean structure for v0.1.0 Open Source release #86

New issue

Closed

opened 2025-08-14 06:27:03 +02:00 by michael · 1 comment

michael commented

2025-08-14 06:27:03 +02:00

Owner

Repository Structure Problem

Current structure (chaotic):

furt/
├── docs-go/              # ❌ Old Go artifacts
├── furt-lua/             # ❌ Wrong nesting (should be root)
│   ├── src/              # ✅ Actual Lua/C source
│   └── config/           # ✅ Actual config
├── go.mod                # ❌ Go artifacts
├── docker-compose.yml    # ❌ Old Docker setup
└── README.md             # ❌ Outdated Go description

Target structure (clean):

furt/
├── src/                  # Lua/C source code
├── config/               # Config templates
├── scripts/              # Small helper scripts (<100 lines)
├── docs/                 # Documentation
├── examples/             # Distribution-specific examples
├── tests/                # Test suite
├── README.md             # Updated for Lua/C
└── VERSION               # Version information

Tasks

Cleanup Phase

Remove Go artifacts (docs-go/, go.mod, docker-compose.yml)
Move furt-lua/* to repository root
Remove obsolete files and directories
Update .gitignore for Lua/C project

Restructure Phase

Create proper src/ directory structure
Organize config/ with distribution examples
Replace monster deployment scripts with small helpers
Add examples/ for different distributions
Create tests/ directory structure

Documentation Phase

Rewrite README.md for Lua/C (remove Go references)
Add VERSION file for semantic versioning
Create basic project documentation structure
Update repository description and tags

Success Criteria

Repository has clean, standard Open Source structure
No Go artifacts remaining
Clear separation: src/, config/, scripts/, docs/
README accurately describes Lua/C implementation
Ready for v0.1.0 packaging and distribution

Blockers

Depends on Issue DAW/furt#71 (Config Strategy) for final config/ structure

Issue DAW/furt#71: Config-Strategy Research
Issue DAW/furt#84: Config change detection
Need: Issue DAW/furt#87: Wiki Documentation Issue (separate)

## Repository Structure Problem **Current structure (chaotic):** ``` furt/ ├── docs-go/ # ❌ Old Go artifacts ├── furt-lua/ # ❌ Wrong nesting (should be root) │ ├── src/ # ✅ Actual Lua/C source │ └── config/ # ✅ Actual config ├── go.mod # ❌ Go artifacts ├── docker-compose.yml # ❌ Old Docker setup └── README.md # ❌ Outdated Go description ``` **Target structure (clean):** ``` furt/ ├── src/ # Lua/C source code ├── config/ # Config templates ├── scripts/ # Small helper scripts (<100 lines) ├── docs/ # Documentation ├── examples/ # Distribution-specific examples ├── tests/ # Test suite ├── README.md # Updated for Lua/C └── VERSION # Version information ``` ## Tasks ### Cleanup Phase - [ ] Remove Go artifacts (docs-go/, go.mod, docker-compose.yml) - [ ] Move furt-lua/* to repository root - [ ] Remove obsolete files and directories - [ ] Update .gitignore for Lua/C project ### Restructure Phase - [ ] Create proper src/ directory structure - [ ] Organize config/ with distribution examples - [ ] Replace monster deployment scripts with small helpers - [ ] Add examples/ for different distributions - [ ] Create tests/ directory structure ### Documentation Phase - [ ] Rewrite README.md for Lua/C (remove Go references) - [ ] Add VERSION file for semantic versioning - [ ] Create basic project documentation structure - [ ] Update repository description and tags ## Success Criteria - Repository has clean, standard Open Source structure - No Go artifacts remaining - Clear separation: src/, config/, scripts/, docs/ - README accurately describes Lua/C implementation - Ready for v0.1.0 packaging and distribution ## Blockers - Depends on Issue DAW/furt#71 (Config Strategy) for final config/ structure ## Related Issues - Issue DAW/furt#71: Config-Strategy Research - Issue DAW/furt#84: Config change detection - Need: Issue DAW/furt#87: Wiki Documentation Issue (separate)

michael added the

labels 2025-08-14 06:27:03 +02:00

michael added this to the v0.1.2 - Gateway Basics milestone 2025-08-14 06:27:37 +02:00

michael referenced this issue

2025-08-14 07:14:25 +02:00

Package Distribution Strategy: Forgejo Packages + GitHub Mirror für Open Source #88

michael referenced this issue

2025-08-14 07:17:59 +02:00

Wiki-based Documentation: Replace monster scripts with user-friendly guides #87

michael referenced this issue from a commit

2025-08-14 09:40:29 +02:00

refactor: clean repository structure for v0.1.0 open source release

michael commented

2025-08-14 09:41:02 +02:00

Author

Owner

Repository Cleanup Complete ✅

Structure cleaned and reorganized:

✅ Go artifacts removed (cmd/, internal/, pkg/, go.mod)
✅ furt-lua/* moved to repository root
✅ Clean structure: src/, config/, scripts/, tests/, deployment/
✅ .temp/cleanup-archive contains old structures

Documentation updated:

✅ README.md rewritten as practical tool documentation
✅ Removed timeline references ("Week 1/2") and marketing language
✅ Focus on functionality: "HTTP-Server that works"
✅ config/server.lua uses example.org defaults

Security improved:

✅ .env.production added to .gitignore
✅ .gitignore cleaned from Go-era artifacts
✅ Generic configuration templates for open source

Ready for v0.1.0:
Repository now has clean, standard Open Source structure without Go legacy artifacts. No confusion from mixed Go/Lua references.

Next: Issue DAW/furt#71 (Config Strategy) can now proceed with clean config/ structure.

## Repository Cleanup Complete ✅ **Structure cleaned and reorganized:** - ✅ Go artifacts removed (cmd/, internal/, pkg/, go.mod) - ✅ furt-lua/* moved to repository root - ✅ Clean structure: src/, config/, scripts/, tests/, deployment/ - ✅ .temp/cleanup-archive contains old structures **Documentation updated:** - ✅ README.md rewritten as practical tool documentation - ✅ Removed timeline references ("Week 1/2") and marketing language - ✅ Focus on functionality: "HTTP-Server that works" - ✅ config/server.lua uses example.org defaults **Security improved:** - ✅ .env.production added to .gitignore - ✅ .gitignore cleaned from Go-era artifacts - ✅ Generic configuration templates for open source **Ready for v0.1.0:** Repository now has clean, standard Open Source structure without Go legacy artifacts. No confusion from mixed Go/Lua references. **Next:** Issue DAW/furt#71 (Config Strategy) can now proceed with clean config/ structure.

michael

2025-08-14 09:41:02 +02:00