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

Improve algolia search results #289

Closed
Tracked by #313 ...
critesjosh opened this issue May 29, 2024 · 7 comments
Closed
Tracked by #313 ...

Improve algolia search results #289

critesjosh opened this issue May 29, 2024 · 7 comments
Assignees

Comments

@critesjosh
Copy link
Collaborator

critesjosh commented May 29, 2024

Problem: Finding things in docs via search can be hit/miss. Eg compare results of searching for "portals" and "cross-chain". Often go to "see all NN results"

Review algolia docs to improve results.

Possible solution (partial): Add meaningful tags to docs, as we go around as part of the "nit" PRs. (h/t @jzaki)

@critesjosh
Copy link
Collaborator Author

Algolia search lets you silo searches based on the "tab" that you are in. research required.

@catmcgee
Copy link
Collaborator

catmcgee commented Aug 7, 2024

filter search results by tag and category
use AI to figure out what they want
only explore the top level menu they are currently on
implement tracking
can implement specific queries
add synonyms
highlight parts of the tect that are relevent
autocomplete

@catmcgee catmcgee self-assigned this Aug 7, 2024
@critesjosh
Copy link
Collaborator Author

critesjosh commented Aug 8, 2024

only explore the top level menu they are currently on

Now that the docs are going to be much more siloed among tabs, do we still want to restrict searches per tab? Maybe we can restrict searches to groups of tabs?

@catmcgee
Copy link
Collaborator

catmcgee commented Aug 8, 2024

ah that was some ideas i was brainstorming during a call we had. definitely dont want to restrict by tab now, but im wondering if we can add filtering by tab or some way for people to see what type of doc it is. im sure there is

@catmcgee
Copy link
Collaborator

rahul feedback
Searching for TXE on our docs doesn't actually show the TXE - https://docs.aztec.network/search?q=txe
Still not clear how to define notes. I searched for "custom notes" but it didn't give a clear picture. Searching for "note" yields far too many results

@critesjosh
Copy link
Collaborator Author

feedback from a community member, on the docs
"Search only Guides. I don't care about protocol specs when I am trying to find something in the docs"

@catmcgee
Copy link
Collaborator

closing in favour of replacing to typesense

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

No branches or pull requests

2 participants