Expand architecture documentation
Open
docs
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 2.1k
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 31
Description
Add an [ARCHITECTURE.md file](https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html) to allow new contributors to learn about the physical architecture of the project easily.
Contributor guide
Research direction
Create ARCHITECTURE.md in the repository. Start by reviewing the project structure and identifying the physical components a new contributor needs to understand. Done means the document gives newcomers a clear overview of the project's architecture and how its parts fit together.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100