Search: add relevancy to API docs to prioritize definitions
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
Meilisearch has a mechanism for relevancy, where you can have one search result win out over the other: https://www.meilisearch.com/docs/learn/core_concepts/relevancy.
This would be useful for API docs. It's common for us to have the same API like my_method show up both as a definition and also in references from other parts of the API docs. We should prioritize the definitions to show up before references.
This requires having structured metadata about where APIs are defined, which we can probably get from the upcoming API components like <Function>: https://github.com/Qiskit/documentation/issues/1008.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the Meilisearch relevancy documentation and the related API components issue #1008 first; the issue does not name implementation files or tests. Define the metadata needed to distinguish API definitions from references, then verify that searches place definitions before references for the same API.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100