Enhance README with better project documentation (features, tech stack, contributors, roadmap, etc.)

[Yogender-verma]

The current README provides a basic overview of the CodePVG LeetCode Ranking project, but it lacks deeper documentation that would improve clarity, onboarding experience, and overall project professionalism.

To make the repository more developer-friendly and open-source ready, the README should be enhanced with structured and detailed sections such as features, architecture, tech stack, working flow, contributor recognition, and future roadmap.

These improvements will help new contributors understand the project faster, encourage participation, and improve the project’s presentation to the wider developer community.

[github-actions]

Thank you for opening an issue.

Please review our CONTRIBUTING.md guidelines before getting started.

A maintainer will review this issue shortly. If you would like to work on the issue yourself, please leave a comment requesting assignment.

[Yogender-verma]

/assign

[jagdish-15]

This feels like a reasonable documentation improvement overall, though I’d prefer keeping the README focused and practical rather than turning it into an overly large or marketing-heavy page.

A clearer explanation of the project/data architecture and some instructions for locally testing the sync-leaderboard workflow would definitely be useful additions. For example, explaining how to clone the data repo as db-repo inside the main repo and run the sync script locally for testing.

At the same time, I’d prefer avoiding things like giant marketing sections, huge badge walls, excessive animations/images, contributor galleries, or overly decorative/fluffy README additions.

Keeping the README clean and developer-focused would fit the project better.

[pallavik2026-hash]

Hii, i would like to work on this issue under GSSoC 2026. Could you please assign it to me?