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.

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

[FEATURE] Improve Documentation – Explain Tech Stack & Architecture #282

Open
PankajVishw50 opened this issue Feb 15, 2025 · 2 comments
Open
Labels
enhancement New feature or request

Comments

@PankajVishw50
Copy link
Contributor

Summary

Improve project documentation by explaining the tech stack, how different technologies integrate, and why they were chosen. This will help beginners and new contributors understand the project better

Description

Hey,
It would be helpful for beginners and new contributors if there were documentation explaining:

  • What different technologies are used in this project.
  • How they work and integrate with each other.
  • Why specific technologies were chosen over alternatives.
  • Having such documentation would make it easier for new contributors to understand the project and contribute effectively.

Let me know your thoughts!
Thanks!

Use Case

No response

Alternatives

No response

Affected Area

Both

@PankajVishw50 PankajVishw50 added the enhancement New feature or request label Feb 15, 2025
@DevilsAutumn
Copy link
Member

@PankajVishw50 Hey! Thanks for creating this issue.

Sounds like a good idea. Do you want to work on this ?

@PankajVishw50
Copy link
Contributor Author

@DevilsAutumn I am myself an beginner and not eligible for this issue.
Someone who is more experienced and have worked on this repo more would be better choice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants