Skip to content

Comments

chore: added software architecture doc / refactor migrations#8

Closed
SeverinAlexB wants to merge 4 commits intomasterfrom
software-architecture
Closed

chore: added software architecture doc / refactor migrations#8
SeverinAlexB wants to merge 4 commits intomasterfrom
software-architecture

Conversation

@SeverinAlexB
Copy link
Collaborator

@SeverinAlexB SeverinAlexB commented Dec 28, 2025

Me playing around with AI

  • AI generated software architecture doc which is pretty good.
  • Refactored migrations with AI. Currently migrations are all defined in the sql folder. This violates the Directed Acyclical Graph though aka sql can access module above. This PR moves the migrations to the individual modules.

@SeverinAlexB SeverinAlexB changed the title chore: added software architecture doc chore: added software architecture doc / refactor migrations Dec 28, 2025
Copy link
Contributor

@86667 86667 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Migration refactor all good 👍

The doc could be trimmed down a bit, the shorter it is the more chance that devs actually read it.

Parts that are probably not needed to be documented:

  • Many of the code examples
  • Directory structure diagram
  • Router factory pattern
  • listing of background tasks and code example of syncer
  • Error handling

All of these details can be found by looking at the code

Things which the doc should be used to explain:

  • Architecture overview and its characteristics
  • How resource sharing works and rules for adding new modules
  • Layer diagrams and layer responsibilities
  • Dependency rules
  • checklist for new modules

@SeverinAlexB
Copy link
Collaborator Author

Closing because I want to keep refining the approach.

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.

2 participants