Skip to content

[DOCS] Update core documentation for v1.1.0 Clean Architecture changesΒ #4

@kadevland

Description

@kadevland

🎯 Issue Summary

Update core documentation to reflect Clean Architecture changes and provide migration guidance for users upgrading from v1.0.x to v1.1.0.

πŸ“š Documentation Files to Update

README.md

Current Issues:
- Structure examples show Application/Interfaces (should be Domain/Contracts)
- Database/ paths instead of Infrastructure/ paths
- Missing new components (gateway, presenter, domain-event, etc.)

Updates Needed:
- Module structure tree with correct paths
- Examples using new Clean Architecture paths
- Updated command examples with new components

CONFIGURATION.md

Current Issues:
- Path examples use old Database/ structure
- Missing documentation for new component types
- Architecture examples need Infrastructure unification

Updates Needed:
- All path examples updated to Infrastructure/
- Documentation for domain-service, domain-event, gateway, presenter
- Updated architecture examples (MVC, DDD, etc.)

CHANGELOG.md

New Content:
- Add v1.1.0 section with breaking changes
- List new component types added
- Reference migration guide

MIGRATION.md (new file)

New File Content:
- Simple 2-strategy migration approach
- Option A: Keep current structure (publish before update)
- Option B: Adopt Clean Architecture (publish after update)
- No complex migration scripts needed

Test Updates

Verify all documentation examples are accurate and consistent with new v1.1.0 configuration structure

Metadata

Metadata

Assignees

Labels

Projects

Status

Backlog

Relationships

None yet

Development

No branches or pull requests

Issue actions