docs: add contribution section to the docs#3396
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a contribution section to the documentation site, making guides for adding models, tasks, and benchmarks accessible. It also includes several corrections to links, typos, and outdated references throughout the documentation files.
- Moves contribution guides from excluded files to the main navigation under a new "Contribute" section
- Updates internal documentation links to use relative paths instead of GitHub URLs
- Fixes various spelling and grammatical errors in the documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| mkdocs.yml | Adds "Contribute" section to navigation and removes exclusion of contribution guide files |
| docs/adding_a_model.md | Updates links to relative paths, fixes typos, and corrects file path references |
| docs/adding_a_dataset.md | Removes unused import, fixes class name reference, and updates example file path |
| mteb/abstasks/retrieval.py | Corrects protocol name reference in documentation string |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
KennethEnevoldsen
left a comment
There was a problem hiding this comment.
I think we can really improve this section a lot. I would probably move contribution to the header, but add a section on "implementing a task" to advanced uses. Similarly to "implementing a model".
should we change the e5 model reference to a citation instead.
voyage link is also broken.
Suggest package link is also broken
We should also change the link the main readme.
Should we make the checklist into easy copy-paste boxes? (code chunks)
|
I will refactor these docs then |
# Conflicts: # mkdocs.yml
|
I've refactored docs a bit. Feel free to edit it |
KennethEnevoldsen
left a comment
There was a problem hiding this comment.
Looks good only a few minor things - feel free to merge after
| If you need to use a custom implementation, you can specify the `loader` parameter in the `ModelMeta` class. | ||
|
|
||
| ??? example "Custom Model Implementation" | ||
| ```python |
There was a problem hiding this comment.
link to the protocols somewhere here
Co-authored-by: Kenneth Enevoldsen <kennethcenevoldsen@gmail.com>
|
@KennethEnevoldsen Seems that test still failing |
Added adding your ... section to the doc site. Maybe we need to refactor it and separate somehow because some links won't work (or leave only doc on site version)