Skip to content

refactor: reorganize repository structure#119

Open
nszceta wants to merge 1 commit intoAndyLevesque:mainfrom
nszceta:refactor/reorganize-repository-structure
Open

refactor: reorganize repository structure#119
nszceta wants to merge 1 commit intoAndyLevesque:mainfrom
nszceta:refactor/reorganize-repository-structure

Conversation

@nszceta
Copy link

@nszceta nszceta commented Jan 15, 2026

Summary

  • Reorganize entire repository into logical directories with consistent kebab-case naming
  • Create libraries/ for shared modules, projects/ for all systems, docs/ for documentation
  • Add README.md to each project directory
  • Separate binary exports into exports/ subdirectories

New Structure

QuackWorks/
├── assets/images/       # GIF files moved from root
├── docs/                # Documentation extracted from README
├── libraries/           # Shared modules (was Modules/)
│   ├── connectors/      # Snap, pushfit, LEGO base
│   └── multiconnect/    # Multiconnect generator
├── projects/            # All main systems
│   ├── underware/       # Cable management
│   ├── deskware/        # Desk system + exports/
│   ├── neogrid/         # Drawer management
│   ├── opengrid/        # Tile generator
│   ├── multiconnect/    # Mounts/holders organized by type
│   └── misc/            # One-off projects
└── tools/               # flake.nix, flake.lock

Changes

  • ~50 files renamed to kebab-case
  • 20+ directories created
  • 8 README files added
  • Documentation moved to docs/
  • Binary exports separated into exports/ subdirectories
  • 11 old directories removed

Break down repository into logical directories with consistent naming.

## Directory Changes
- Rename Modules/ → libraries/ with subdirectories (connectors/, multiconnect/)
- Create projects/ with subdirectories for each system
- Create assets/images/ for media files
- Create docs/ for documentation
- Create tools/ for development tools (flake.nix)

## Project Organization
- underware/: Organized into channels/, accessories/, scripts/, in-progress/, deprecated/
- deskware/: Added exports/ subdirectory for binary files
- neogrid/: Consolidated into single directory
- opengrid/: Consolidated into single directory (lowercase for consistency)
- multiconnect/: Organized by type (holders/, shelves/, storage/, hooks/, adapters/)
- misc/: Consolidated one-off projects

## Naming Conventions
- All files renamed to kebab-case
- Directories use kebab-case
- Consistent lowercase for all project directories

## Documentation
- Added README.md to each project directory and libraries/
- Moved Multiconnect Development Standards to docs/multiconnect-standards.md
- Updated root README.md with new structure

## Cleanup
- Removed empty directories (MultiConnectOpenSCAD, OfficialProfiles)
- Removed obsolete file (UnderwareBuilder_old.py)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant