Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: update docs according to current state #1870

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

Samoed
Copy link
Collaborator

@Samoed Samoed commented Jan 24, 2025

Checklist

  • Run tests locally to make sure nothing is broken using make test.
  • Run the formatter to format the code using make lint.

Closing #1868

@isaac-chung isaac-chung changed the title feat: update docs according to current state Docs: update docs according to current state Jan 25, 2025
Copy link
Collaborator

@isaac-chung isaac-chung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for quickly starting the effort!

Added a few suggestions. We should also update the README file as well since one file is removed. There, we should also add a line pointing out that the "adding a model" instructions is equivalent to adding a model to the leaderboard.

docs/adding_a_benchmark.md Outdated Show resolved Hide resolved
docs/adding_a_benchmark.md Outdated Show resolved Hide resolved
docs/adding_a_benchmark.md Outdated Show resolved Hide resolved
docs/adding_a_model.md Outdated Show resolved Hide resolved
docs/adding_a_model.md Outdated Show resolved Hide resolved
docs/adding_a_model.md Outdated Show resolved Hide resolved
docs/adding_a_model.md Outdated Show resolved Hide resolved
docs/adding_a_model.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants