Lacking developer documentation required for open development and onboarding

What was unclear or otherwise insufficient?

Hi!

I'm happy to see that TypeORM is returning back to active development! I'm sure that the new developers are deepening their understanding of the codebase as we speak.

Unless I missed it, I don't really see any documentation on how TypeORM works internally, no software diagrams, or other illustrations of the flow through the code, what sort of query planning it does, ...

I'd like to join the open development of TypeORM and contribute where I can (while TypeORM was abandoned I maintained a little fork), and this type of documentation would make it a lot easier for Open Source developers to efficiently contribute.

Recommended Fix

Add developer documentation, including perhaps:

• For each user facing API (QueryBuilder, EntityManager, Repository, ...) sketch which parts of the code we step through to arrive at the query execution, and how when the data arrives back from the DB we end up back at the user with the processed results
• Explain how TypeORM plans queries
• Explain the design philosophy that should be followed so we can evaluate different approaches and select the most suitable one for TypeORM

Additional Context

No response

Are you willing to resolve this issue by submitting a Pull Request?

Yes, I have the time, but I don't know how to start. I would need guidance.