🐞[Bug]: write a detailed documentation about the leaderboard creation and API usage.

[sanjay-kv]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

We need comprehensive documentation detailing the process of leaderboard creation within Recode Hive, along with clear explanations and examples on how to use the relevant APIs.

Requirements:

do it here: https://github.com/recodehive/recode-website/wiki/Documentation-of-Leaderboard

Step-by-step instructions on how the leaderboard feature is designed and implemented.

Detailed guide for backend and frontend integration (data flow, models, UI components).

API reference documentation, including:

Endpoints

Methods (GET, POST, etc.)

Expected request parameters and example payloads

Response formats and example responses

Common error codes or edge cases

Code snippets and usage examples demonstrating typical API interactions (creation, updates, fetching, etc.).

Diagrams or flowcharts to illustrate how leaderboard data is synced between client and server (if applicable).

Section for best practices, security, and scalability considerations related to leaderboard management.

entation, API, and leaderboard.

Expected behavior

Acceptance Criteria:

Markdown documentation file(s) are created or updated in the repository (e.g. docs/leaderboard.md).

The documentation is thorough, beginner-friendly, and reviewed for clarity.

All API usage is covered with at least one working example per endpoint.

Linked or referenced in the main repository README and/or developer onboarding guide.

Additional Notes:

Collaborate with the team to gather technical details and review drafts.

Screenshots or GIFs of the leaderboard UI are a welcome addition.

Please label this issue as docum

Add ScreenShots

No response

What browsers are you seeing the problem on?

No response

Record

• I have read the Contributing Guidelines
• Are you a GSSOC'25 contributor
• I want to work on this issue

[github-actions]

Thanks for opening this issue! 🎉 We'll look into it as soon as possible, estimated time for response is 5–8 hrs.

Don't raise PR unless assigned to you.

In the meantime, please provide all necessary details and context to your issue — screenshots or videos of your changes help speed up the review and assignment. If you have questions, reach out to LinkedIn. Your contributions are highly appreciated!😊

Note: I maintain the repo issue every day twice at 8:00 AM IST and 9:00 PM IST. If your issue goes stale for more than one day, you can tag and comment on this same issue by tagging @sanjay-kv.

We are here to help you on this journey of open source. Consistent contributions are eligible for sponsorship 💰

🎁 check our list of amazing people we sponsored so far: GitHub Sponsorship. ✨

📚Resources which can help you know more about Github 👇🏻

1. End to End GitHub Beginner Playlist: GitHub Playlist.

2. Build your GitHub Profile: GitHub Profile Optimisation.

3. GitHub Handbook for dummies: GitHub Blog for Beginners.

[Adez017]

i would like to work on this @sanjay-kv

[github-actions]

👤 Issue assigned to @Adez017.

[sanjay-kv]

@Adez017 is this part done?

[Adez017]

@Adez017 is this part done?

Still need to be done , will update by evening @sanjay-kv