[NEW] Documentation for Open-Source Leaderboard Component

[samad-yar-khan]

• I have read the Contributing Guide - https://github.com/RocketChat/Rocket.Chat/blob/develop/.github/CONTRIBUTING.md#contributing-to-rocketchat doc
• I have signed the CLA - https://cla-assistant.io/RocketChat/Rocket.Chat
• Lint and unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works (if applicable)
• I have added necessary documentation (if applicable)
• Any dependent changes have been merged and published in downstream modules

Proposed changes (including videos or screenshots)

Added documentation for Open-Source Leaderboard Component to make it easier for community builders to setup their own contribution leader board component and understand the flow of data from the cms to the component.

• Note : The only warning being displayed on console now are due to the issues persisting in the react-slick library. Reference

Issue(s)

Fixes : #69

Steps to test or reproduce

Mentioned in the Issue

Before :

After :

[samad-yar-khan]

@Sing-Li I have made the documentation for the component. Made it a bit more descriptive so that anyone (community builders as well as other contributors) can setup the component and understand the working. Let me know if there are any changes. 😄

[Sing-Li]

Please create a sub-directory named leaderboard and put your docs in the README.md there.

At this level there should just be a link from a list item leaderboard to that subdirectory.

This will allow the addition of other components to this page.

[samad-yar-khan]

Got it ! Will just do that.

[samad-yar-khan]

@Sing-Li I have created a leaderboard subdirectory and linked the leaderboard documentation with the main components documentation. This should allow addition of documentation of other components as well.

2022-02-04.01-58-19.mp4