Skip to content

[Docs] Final Revision of Core Architecture Documentation and Project Cleanup #40

@mahdibayouli

Description

@mahdibayouli

📝 Description

The current state of the architecture documentation (especially UML diagrams) needs a final revision to reflect the current implementation. Additionally, leftover or obsolete project files and inconsistencies should be cleaned up to prepare for handover, onboarding, or deployment documentation.


📖 User Story

As a developer or team lead,
I want to finalize the core architecture documentation and remove outdated project files,
so that the system design is clearly communicated and the repository remains clean, understandable, and maintainable.


🎯 Acceptance Criteria

  • All core components are documented using updated UML diagrams (e.g., component, class, and sequence diagrams)
  • All diagrams are up to date with the current codebase and aligned with implemented service boundaries
  • The docs/ or architecture/ folder contains the final version of all diagrams and architectural decisions
  • Obsolete or unused files, folders, or code artifacts are removed from the repository
  • README and relevant documentation are updated to reflect recent changes
  • Optional: Include a changelog entry summarizing the final revision

🛠️ Proposed Solution

  • Review all UML diagrams and regenerate if necessary (e.g., using PlantUML, Structurizr, or IntelliJ)
  • Cross-check diagrams with services like course-service, user-service, genai-service, and frontend structure
  • Remove temporary/test files or deprecated code paths
  • Ensure file naming, folder structure, and documentation links are consistent

📂 Affected Components

  • docs/
  • architecture/
  • Root-level documentation (README, CONTRIBUTING.md)
  • Any deprecated code in backend or frontend services

🔗 Related Issues / Merge Requests

(Link to relevant documentation or cleanup tasks, if any)


👥 Assignees

@mahdibayouli & @GravityDarkLab


⏱️ Priority

  • Critical
  • High
  • Medium
  • Low

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions