chore: added software architecture doc / refactor migrations#8
Closed
SeverinAlexB wants to merge 4 commits intomasterfrom
Closed
chore: added software architecture doc / refactor migrations#8SeverinAlexB wants to merge 4 commits intomasterfrom
SeverinAlexB wants to merge 4 commits intomasterfrom
Conversation
86667
approved these changes
Dec 29, 2025
Contributor
86667
left a comment
There was a problem hiding this comment.
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
Collaborator
Author
|
Closing because I want to keep refining the approach. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.