Issue #49.4: Organize architecture documentation (move ARCHITECTURE.md, CAPABILITIES.md, etc.) #77

New Issue

tegwick · 2025-10-02T19:37:11Z

tegwick commented

2025-10-02 19:37:11 +00:00

Summary

Reorganize architecture-related documentation files into proper docs/architecture/ structure and eliminate redundancies following arc42 documentation standards.

Parent Issue

This is a subtask of Issue #49: "Organize documentation using the DRY principle and arc42"

Files to Move/Organize

Core Architecture (to docs/architecture/)

ARCHITECTURE.md (20,423 bytes) - main architecture document
CAPABILITIES.md (17,940 bytes) - system capabilities overview
DOMAIN_LOGIC_SEPARATION_DEMO.md (14,332 bytes) - domain architecture example

Integration Architecture (to docs/architecture/integration/)

LEGACY_COMPATIBILITY_SYSTEM.md (18,917 bytes) - legacy system integration

Existing Architecture Docs (review and consolidate)

docs/architecture/ (existing directory)

Acceptance Criteria

Review existing docs/architecture/ content for overlaps
Move architecture files to appropriate subdirectories
Consolidate any duplicate or overlapping content
Create clear architecture navigation structure
Follow arc42 architecture documentation template sections
Update all cross-references and links
Create consolidated architecture index
Ensure no information is lost during reorganization

Estimated Effort

3 hours

Labels

documentation
organization
dry-principle
architecture
priority:high

Dependencies

None - this can be done independently

## Summary Reorganize architecture-related documentation files into proper docs/architecture/ structure and eliminate redundancies following arc42 documentation standards. ## Parent Issue This is a subtask of Issue #49: "Organize documentation using the DRY principle and arc42" ## Files to Move/Organize ### Core Architecture (to docs/architecture/) - ARCHITECTURE.md (20,423 bytes) - main architecture document - CAPABILITIES.md (17,940 bytes) - system capabilities overview - DOMAIN_LOGIC_SEPARATION_DEMO.md (14,332 bytes) - domain architecture example ### Integration Architecture (to docs/architecture/integration/) - LEGACY_COMPATIBILITY_SYSTEM.md (18,917 bytes) - legacy system integration ### Existing Architecture Docs (review and consolidate) - docs/architecture/ (existing directory) ## Acceptance Criteria - [ ] Review existing docs/architecture/ content for overlaps - [ ] Move architecture files to appropriate subdirectories - [ ] Consolidate any duplicate or overlapping content - [ ] Create clear architecture navigation structure - [ ] Follow arc42 architecture documentation template sections - [ ] Update all cross-references and links - [ ] Create consolidated architecture index - [ ] Ensure no information is lost during reorganization ## Estimated Effort 3 hours ## Labels - documentation - organization - dry-principle - architecture - priority:high ## Dependencies None - this can be done independently

tegwick added this to the Clean Repository Standard project 2025-10-02 20:15:32 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: coulomb/markitect-main#77