Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs: document a high level overview of the project #2604

Open
orgarten opened this issue Nov 3, 2023 · 1 comment
Open

Docs: document a high level overview of the project #2604

orgarten opened this issue Nov 3, 2023 · 1 comment
Labels
Documentation 📚 This is related to documentation Enhancement This is a new feature or request

Comments

@orgarten
Copy link
Contributor

orgarten commented Nov 3, 2023 •
edited by polar-sh bot
Loading

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
@orgarten orgarten added the Enhancement This is a new feature or request label Nov 3, 2023
@AgarwalPragy
Copy link
Contributor

Related: litestar-org/litestar-fullstack#35

@JacobCoffee JacobCoffee added the Documentation 📚 This is related to documentation label Dec 7, 2023
@JacobCoffee JacobCoffee changed the title Enhancement: document a high level overview of the project Docs: document a high level overview of the project Dec 7, 2023
@github-project-automation github-project-automation bot moved this to Triage in Overview Dec 8, 2023
@JacobCoffee JacobCoffee moved this from Triage to Backlog in Overview Dec 8, 2023
@JacobCoffee JacobCoffee moved this from Backlog to Ideas in Overview Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation 📚 This is related to documentation Enhancement This is a new feature or request
Projects
Overview
Status: Ideas
Milestone
No milestone
Development

No branches or pull requests
3 participants
@AgarwalPragy @orgarten @JacobCoffee