filecoin-docs icon indicating copy to clipboard operation
filecoin-docs copied to clipboard

Optimize Results of AI Search Tool

Open robertagora opened this issue 8 months ago • 4 comments

Some small issues have been noted with the docs AI search tool.

For example, the search for "sector" gives the best possible result as the seventh option:

Image

Conversation in slack: https://filecoinproject.slack.com/archives/C0745JU645A/p1744827963799379

robertagora avatar Apr 17 '25 17:04 robertagora

@barbaraperic can we see if we can tweak the search settings at all in gitbook?

smagdali avatar Apr 20 '25 01:04 smagdali

@barbaraperic can we see if we can tweak the search settings at all in gitbook?

It seems like although Sector appears as a heading in Glossary page, other pages are prioritise because of the high frequency of keyword mentions (ex. 33 mentions in Sealing pipeline page).

There are a few things we could do to boost Glossary in search:

  • add Last updated tag - signals to search engines that your content is fresh, which can boost rankings
  • expand on the page description (current: "Definitions and usage for Filecoin terminology", recommended: "Authoritative definitions and proper usage for all Filecoin terminology, including sectors, storage providers, sealing, and blockchain concepts. The definitive reference for understanding Filecoin technical terms."
  • add a strong introduction paragraph at the top of your Glossary that features key terms prominently. Recommendation: "This comprehensive glossary provides authoritative definitions for all Filecoin terminology, including detailed explanations of sectors, storage mechanisms, and network roles. Use this as your definitive reference for understanding Filecoin technical concepts."

Resource

Let me know thoughts and if you want me to test these options :)

barbaraperic avatar Apr 24 '25 08:04 barbaraperic

Looks like we should do these - can we also pull a log of existing queries to see what people are searching for? would be useful real world data.

smagdali avatar May 01 '25 01:05 smagdali

Looks like we should do these - can we also pull a log of existing queries to see what people are searching for? would be useful real world data.

Great idea! I've made a list of top 12 search queries in the past 3 months and listed their current first-result destinations - see here.

Action items:

  • Can you please review the attached list of top search queries and their current first results
  • In the "Suggestion for the 1st result" column, indicate which destinations you'd like to change
  • I'll implement the changes as discussed here

barbaraperic avatar May 07 '25 12:05 barbaraperic