Summary
I believe litestar would benefit from an architectural documentation giving a high level overview of the project.
Questions like this could be addressed:
- What is the general project structure?
- How do different modules interact with each other?
- What's the idea/philosophy behind plugins and how can I write my own plugin?
- ...
There are probably a lot more questions that could be addressed. In my opinion, the main goal should be to help (new) developers understand where to look when trying to fix a bug or write an enhancement.
Basic Example
No response
Drawbacks and Impact
Needs to be kept up-to-date, just like any documentation. I would imagine this stays relatively stable, though.
Unresolved questions
No response
Summary
I believe litestar would benefit from an architectural documentation giving a high level overview of the project.
Questions like this could be addressed:
There are probably a lot more questions that could be addressed. In my opinion, the main goal should be to help (new) developers understand where to look when trying to fix a bug or write an enhancement.
Basic Example
No response
Drawbacks and Impact
Needs to be kept up-to-date, just like any documentation. I would imagine this stays relatively stable, though.
Unresolved questions
No response