Issue
- The README.md file is currently sparse and lacks comprehensive documentation.
- New or beginner contributors don’t have clear instructions to get started.
- The purpose and structure of the project files are not described.
Suggestions
- Create a project board or an epic/parent issue with sub-issues for improving documentation.
- Expand setup instructions to be more beginner-friendly.
- Add a table describing each file/folder and its purpose in the repository.
Why
- Improved documentation benefits everyone, developers, recruiters, contributors, and casual viewers, by making the project easier to understand without diving into the code.
- Clear guidance helps contributors submit focused, relevant PRs.
Personal note:
Although I’ve been away from this project, it has been a great way for me to learn contribution workflows and explore building my own projects here. I'd love for others to have the same experience.
Issue
Suggestions
Why