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

Search: add relevancy to API docs to prioritize definitions #1062

Open
Tracked by #1065
Eric-Arellano opened this issue Mar 19, 2024 · 0 comments
Open
Tracked by #1065

Search: add relevancy to API docs to prioritize definitions #1062

Eric-Arellano opened this issue Mar 19, 2024 · 0 comments

Comments

@Eric-Arellano
Copy link
Collaborator

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>: #1008.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant