Skip to content

Insufficient documentation on the Domain Model #509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jakob-info opened this issue Apr 28, 2025 · 2 comments
Open

Insufficient documentation on the Domain Model #509

jakob-info opened this issue Apr 28, 2025 · 2 comments

Comments

@jakob-info
Copy link
Contributor

Could you share a visualization of the Domain Model if it exists, please?
Example:(https://upload.wikimedia.org/wikipedia/commons/2/2d/Domain_model.png)

Also I couldn't find any documentation on how the Abstract classes are generated. There are no readme files in backend/app/DomainObjects From which files are they generated? Is the source outside the repository? It just says
"THIS FILE IS AUTOGENERATED - DO NOT EDIT IT DIRECTLY".

@daveearley
Copy link
Contributor

Hi @jakob-info,

Yes, I will put together some additional documentation on the structure of the BE.

For the Abstract classes, it's mentioned in the contribution guidelines. Some more thorough documentation is definitely needed though. I'll work on that soon.

@jakob-info
Copy link
Contributor Author

Thanks, i overlooked that

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

No branches or pull requests

2 participants